authenticate

Authenticates a client / device by a JSON Web Token. After successful authentication, all subsequent messages may exclude JSON Web Token parameter.

Request Message

Authorization

None

Message Representation

{
    "action": {string},
    "requestId": {object},
    "token": {string}
}

Message Parameters

Property NameRequiredTypeDescription
actionYesstringAction name: authenticate
requestIdNoobjectRequest unique identifier, will be passed back in the response message.
tokenYesobjectAccess JSON Web Token.

Response Message

Message Representation

{
    "action": {string},
    "status": {string},
    "requestId": {object}
}

Message Parameters

Property NameTypeDescription
actionstringAction name: authenticate
statusstringOperation execution status (success or error).
requestIdobjectRequest unique identifier as specified in the request message.