Schemas
Alias
| Property | Type | Description |
|---|---|---|
aliases |
List of
|
A list of alternates names that the device can authenticate with. Must conform to UTF-8. |
ApplicationMembers
| Property | Type | Description |
|---|---|---|
resourceVersion |
|
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 |
{
"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* |
|
CommandObject
Additional command payload.
Type:
Map of objects
{
"set-temp": 21,
"set-light-color": "FDF4DC"
}
DeviceSpec
A JSON object containing arbritrary data attached to a device.
| Property | Type | Description |
|---|---|---|
credentials |
||
gatewaySelector |
||
alias |
DeviceStatus
A JSON object containing arbritrary status information attached to a device.
Type:
Map of objects
GatewaySelector
| Property | Type | Description |
|---|---|---|
matchNames |
List of
|
Each: The device ID of the device to use as a gateway. |
Metadata
| Property | Type | Description |
|---|---|---|
creationTimestamp* |
(date-time) |
|
name* |
|
|
resourceVersion* |
|
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* |
|
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* |
|
|
deletionTimestamp |
(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
|
A list of finalizers. As long as finalizers are present, the resource will not be deleted
even if the |
annotations |
Map of
|
Arbitrary additional information. |
labels |
Map of
|
Additional labels which can used for searching. Labels are limited in size and format, similar to the Kubernetes labels. Also see: |
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
RequestBodyApiAdminV1alpha1AppsAppIdTransferOwnershipPutApplicationJson
| Property | Type | Description |
|---|---|---|
newUser* |
|
ResponseApiAdminV1alpha1AppsAppIdTransferOwnershipGet200ApplicationJson
| Property | Type | Description |
|---|---|---|
newUser* |
|
ResponseApiAdminV1alpha1UserWhoamiGet200ApplicationJson
| Property | Type | Description |
|---|---|---|
id* |
|
The ID of the current user. NOTE: This ID may be different to the name of the user. |
ResponseApiTokensV1alpha1Get200ApplicationJsonItems
| Property | Type | Description |
|---|---|---|
created |
(date-time) |
|
prefix |
|
ResponseApiTokensV1alpha1Post200ApplicationJson
| Property | Type | Description |
|---|---|---|
key* |
|
|
prefix* |
|
ScopedMetadata
All of:
-
Property Type Description application*stringThe name of the application the resource is scoped to.
UserCredential
Username and password credentials.
| Property | Type | Description |
|---|---|---|
user* |
The username and password combination. |