DRIVR Local Api Tokens MQTT API for Connectors 1.1.0 documentation

DRIVR Local Api Tokens MQTT API for Connectors 1.1.0

This page provides an overview of all MQTT topics that can be used to retrieve LocalApiToken information within DRIVR. These tokens are generally used for on-device API authentication and generated and downloaded from the cloud using the below topics. The JWKs information provided by DRIVR enables the device to verify token authenticity even if the connection to the cloud is limited or intermittent. For more information please refer to the following guide: Local Api Tokens. PLEASE NOTE: For comprehensive explanations of terms such as Domain, System, Component, Event, Service, Characteristic, and others used in this document, please refer to Terms.

Servers

mqtt://mqtt.drivr.cloud:{port}/secure-mqtt 3.1.1drivr-mqtt-broker
DRIVR MQTT Broker
object
port
required
string
Default value:"8883"
Allowed values:
"8883"

Operations

SUB drivr/v1/{slug}/jwks
Returns the Json Web Keys for the domain.

Operation IDgetDomainJwks
Available only on servers:
- drivr-mqtt-broker
object
slug
required
string
The slug of your individual Domain.

Examples values:
"adam"
"eve"
object
retained
true
Accepts the following message:
<anonymous-message-1>
application/json
Message ID<anonymous-message-1>
The JSON Web Key Set (JWKS) for the domain.

object
array<object>
The keys which are used to verify the JWT token.

e
string
The exponent of the public key.

Examples values:
"AQAB"
kid
string
The key identifier.

Examples values:
"1"
kty
string
The key type.

Examples values:
"RSA"
n
string
The modulus of the public key.

Examples values:
"1"
Additional properties are NOT allowed.
Examples
{ "keys": [ { "e": "AQAB", "kid": "1", "kty": "RSA", "n": "1" } ] }

This example has been generated automatically.
SUB drivr/v1/{slug}/authorization/localApiTokens/{systemUuid}
Returns the local api tokens for the provided System. These tokens can be used by systems which provide a local API to authenticate DRIVR users against the local API.

Operation IDgetLocalApiTokens
Available only on servers:
- drivr-mqtt-broker
object
slug
required
string
The slug of your individual Domain.

Examples values:
"adam"
"eve"
systemUuid
required
string
format: uuid
The unique UUID of the System within DRIVR.

Examples values:
"24ee14a3-f1c8-49aa-95fc-ad0432e23b99"
object
retained
true
Accepts the following message:
<anonymous-message-2>
application/json
Message ID<anonymous-message-2>
The payload to be processed by DRIVR to authenticate a User on the local API provided by a system.

array<object>
uuid
string
format: uuid
A specific authentication token which represents a token, a role reference and a reference for whom the token is created.

Examples values:
"9c4b33e9-f84c-4aaa-ad37-74f0078901a2"
status
string
The status of the LocalApiToken. REVOKED results in the token which has been revoked and should not be accepted.

Allowed values:
"ACTIVATED"
"REVOKED"
Examples values:
"ACTIVATED"
"REVOKED"
createdAt
string
format: date-time
The timestamp when the LocalApiToken was created.

Examples values:
"2021-08-06T13:13:06.136333+00:00"
expiresAt
string
format: date-time
The timestamp when the LocalApiToken expires.

Examples values:
"2021-08-06T13:13:06.136333+00:00"
notBefore
string
format: date-time
The timestamp when the LocalApiToken is valid from.

Examples values:
"2021-08-06T13:13:06.136333+00:00"
systemUuid
string
format: uuid
The UUID of the System which the LocalApiToken is valid for.

Examples values:
"9c4b33e9-f84c-4aaa-ad37-74f0078901a2"
array<object>
The roles which the subject has within the system. This should be updated in an internal database and have precedence from the data in the JWT token as it is updated when the roles update in DRIVR.

uuid
string
format: uuid
The UUID of the role which the token authenticates.

Examples values:
"2faa6870-91b0-4b3a-84e8-8bbbd8becbd0"
name
string
The name of the role which the token authenticates.

Examples values:
"System Maintainer"
token
string
The token which is used to authenticate the system.

Examples values:
"CLOUD-eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9"
object
The entity which the token authenticates.

uuid
string
format: uuid
The UUID of the entity which the token authenticates.

Examples values:
"60c5ba79-6d1a-4623-99df-3f423d7c7d0c"
"23242b19-d336-4b03-8618-f29363335447"
name
string
The name of the entity which the token authenticates.

Examples values:
"Ada Lovelace"
"Marie Curie"
type
string
The type of the entity which the token authenticates.

Allowed values:
"USER"
Examples values:
"USER"
Additional properties are allowed.
Examples
[ { "uuid": "9c4b33e9-f84c-4aaa-ad37-74f0078901a2", "status": "ACTIVATED", "createdAt": "2021-08-06T13:13:06.136333+00:00", "expiresAt": "2021-08-06T13:13:06.136333+00:00", "notBefore": "2021-08-06T13:13:06.136333+00:00", "systemUuid": "9c4b33e9-f84c-4aaa-ad37-74f0078901a2", "roles": [ { "uuid": "2faa6870-91b0-4b3a-84e8-8bbbd8becbd0", "name": "System Maintainer" } ], "token": "CLOUD-eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9", "subject": { "uuid": "60c5ba79-6d1a-4623-99df-3f423d7c7d0c", "name": "Ada Lovelace", "type": "USER" } } ]

This example has been generated automatically.

DRIVR Local Api Tokens MQTT API for Connectors 1.1.0

Servers

Operations

SUB drivr/v1/{slug}/jwks

Examples

This example has been generated automatically.

SUB drivr/v1/{slug}/authorization/localApiTokens/{systemUuid}

Examples

This example has been generated automatically.