Schemas

Alias

Property Type Description

aliases

List of string

A list of alternates names that the device can authenticate with. Must conform to UTF-8.

App

Property Type Description

metadata

NonScopedMetadata

spec

ApplicationSpec

status

ApplicationStatus

ApplicationMembers

Property Type Description

resourceVersion

string

The version of the resource. When setting a new member list, this value is optional. But if present, the application will only be updated if the resource version matches. Otherwise it will return a "Conflict".

members*

Map of MemberEntry

Example
{
  "resourceVersion": "ced63698-a0da-11eb-97e8-d45d6455d2cc",
  "members": {
    "d84eb308-a0da-11eb-9e90-d45d6455d2cc": {
      "role": "admin"
    },
    "03e32c1a-a0db-11eb-9e9b-d45d6455d2cc": {
      "role": "manager"
    },
    "0a111dfe-a0db-11eb-a953-d45d6455d2cc": {
      "role": "reader"
    }
  }
}

ApplicationSpec

A JSON object containing arbritrary data attached to an application.

Type:

Map of objects

ApplicationStatus

A JSON object containing arbritrary status information attached to an application.

Type:

Map of objects

CertCredential

The public key of the device X509 certificate.

Property Type Description
cert*

string

CommandName

The name of the command.

Type: string

Example
"set-value"

CommandObject

Additional command payload.

Type:

Map of objects

Example
{
  "set-temp": 21,
  "set-light-color": "FDF4DC"
}

Device

Property Type Description

metadata

ScopedMetadata

spec

DeviceSpec

status

DeviceStatus

DeviceCredentials

DeviceSpec

A JSON object containing arbritrary data attached to a device.

Property Type Description

authentication

DeviceSpec_authentication

gatewaySelector

GatewaySelector

alias

Alias

DeviceSpec_authentication

Property Type Description

credentials

DeviceCredentials

DeviceStatus

A JSON object containing arbritrary status information attached to a device.

Type:

Map of objects

GatewaySelector

Property Type Description

matchNames

List of string

Each: The device ID of the device to use as a gateway.

MemberEntry

Property Type Description
role*

string

  • reader

  • writer

  • admin

Metadata

Property Type Description
creationTimestamp*

string

(date-time)

name*

string

resourceVersion*

string

An ID of the current version of this resource. This should be treated as a string and its content should not be interpreted by clients in any way.

uid*

string

A unique ID of the resource. Deleting and re-creating a resource with the same name will still result in a different unique ID.

generation*

integer

deletionTimestamp

string

(date-time)

A marker for soft-deletion. When the resource is deleted, it will first be marked as deleted, by setting the deletion timestamp. Once all finalizers are removed, the resource will actually be deleted.

finalizers

List of string

A list of finalizers. As long as finalizers are present, the resource will not be deleted even if the deletionTimestamp is set.

annotations

Map of string

Arbitrary additional information.

labels

Map of string

Additional labels which can used for searching.

Labels are limited in size and format, similar to the Kubernetes labels.

Also see:

NonScopedMetadata

All of:

PassCredential

password credential.

Property Type Description
pass*

Password

Password

A password, either plain or hashed.

One of:

  • string

  • Property Type Description
    plain*

    string

  • Property Type Description
    bcrypt*

    string

  • Property Type Description
    sha512*

    string

PSKCredential

A pre shared key used for TLS-PSK encryption.

Property Type Description
key*

string

Base64 encoded key.

validity

Validity

RequestBodyApiAdminV1alpha1AppsApplicationTransferOwnershipPutApplicationJson

Property Type Description
newUser*

string

ResponseApiAdminV1alpha1AppsApplicationTransferOwnershipGet200ApplicationJson

Property Type Description
newUser*

string

ResponseApiAdminV1alpha1UserWhoamiGet200ApplicationJson

Property Type Description
id*

string

The ID of the current user.

NOTE: This ID may be different to the name of the user.

ResponseApiTokensV1alpha1Get200ApplicationJsonItems

Property Type Description

created

string

(date-time)

prefix

string

ResponseApiTokensV1alpha1Post200ApplicationJson

Property Type Description
key*

string

prefix*

string

ResponseWellKnownDrogueVersionGet200ApplicationJson

Property Type Description
success*

string

  • true

ScopedMetadata

All of:

  • Property Type Description
    application*

    string

    The name of the application the resource is scoped to.

Timeout

Type: integer

Example
30

UserCredential

Username and password credentials.

Property Type Description
user*

UserCredential_user

The username and password combination.

UserCredential_user

The username and password combination.

Property Type Description

usename

string

password

Password

Validity

Timestamps constraining the validity of a PSK.

Property Type Description

notBefore

string

RFC 3339 encoded date. Before this date the key will be invalid.

notAfter

string

RFC 3339 encoded date. After this date the key will be invalid.