Skip to content

Tokens

Validate a Token

/api/v2/tokens/validate 📋 Copied! ▼

Role: No token needed. Use this endpoint to check a temporary access token before you use it.

Parameters

No parameters

Request body required

{
  "token": "string"
}

Responses

Code Description
200

The token is valid. The response has no body.
400

Invalid token.

List Tokens

/api/v2/tokens 📋 Copied! ▼

Parameters

Name Description
page Zero-based page number.
Type: integer (query)
Default value: 0
size Page size.
Type: integer (query)
Default value: 20
sort The sort type for listing entries.
Type: string (query)
mobileId Only list the tokens of this Mobile Device.
Type: integer (query)

Role: Admin.

Responses

Code Description
200

OK

Media type: application/json

Example Value:

{
  "totalElements": 0,
  "totalPages": 0,
  "number": 0,
  "sort": {
    "sorted": true,
    "unsorted": true,
    "empty": true
  },
  "size": 0,
  "content": [
    {
      "id": 0,
      "token": "string"
    }
  ],
  "first": true,
  "last": true,
  "pageable": {
    "sort": {
      "sorted": true,
      "unsorted": true,
      "empty": true
    },
    "offset": 0,
    "paged": true,
    "unpaged": true,
    "pageNumber": 0,
    "pageSize": 0
  },
  "numberOfElements": 0,
  "empty": true
}

Create a Token

/api/v2/tokens 📋 Copied! ▼

Parameters

No parameters

Request body required

{
  "mobileId": 0,
  "fullControl": true,
  "expiryHours": 0
}

Responses

Code Description
201

Created Token with ID.

Media type: application/json

Example Value:

{
  "id": 0,
  "token": "string"
}

Delete a Token

/api/v2/tokens/{id} 📋 Copied! ▼

Parameters

Name Description
id * Numeric ID of the Token.
Type: integer (path)

Responses

Code Description
200 Token was deleted successfully.
404 Resource was not found.