API Tokens

The API Token object represents a user authentication token within the platform.

This object contains the following attributes:

Field	Type	Description
id	string	The primary identifier for the token. Example: TKN-1671-0642
href	string	The relative reference to the object in the API. Example: /v1/accounts/accounts/ACC-1671-0642/tokens/TKN-4134-7330
name	string	The name of the token. Example: Robot
description	string	A description of the token. Example: Test token
status	string	The token's status with one of these possible values: Active, Disabled, or Deleted.
modules	module	Module validation when creating API Token.
account	account	The account under which the token has been defined. Example: { "id": "ACC-123-123", "name": "Microsoft" }
token	string	The token's authentication code.

Example

API TOKEN OBJECT

{
    "id": "TKN-4134-7330",
    "name": "Name",
    "description": "Description",
    "icon": "",
    "status": "Active",
    "modules": [
        {
            "id": "MOD-1756-1452"
        },
        {
            "id": "MOD-9042-8216"
        }
    ],
    "token": "CODE"
}