API Token

An API Token represents a user authentication token within the platform.

This object contains the following attributes:

Field	Type	Description
id	string, core	(Read-only) The primary identifier for the token.
name	string, core	The name of the token.
description	string	(Optional) A description of the token.
icon	string, core	(Optional) The relative path to the API token icon.
status	string	(Read-only) The token's status. Allowed values: Active Disabled Deleted
modules	module	Module validation when creating API token.
account	object	Represents the account object under which the token has been defined. Example: { "id": "ACC-123-123", "name": "Microsoft" }
token	string	(Read-only) The token's authentication code.
audit	object	(Read-only) Represents the audit object.

Example

API TOKEN OBJECT

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