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 Name

Required

Type

Description

action

Yes

string

Action name: authenticate

requestId

No

object

Request unique identifier, will be passed back in the response message.

token

Yes

object

Access JSON Web Token.

Response Message

Message Representation

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

Message Parameters

Property Name

Type

Description

action

string

Action name: authenticate

status

string

Operation execution status (success or error).

requestId

object

Request unique identifier as specified in the request message.