API Tokens

The API Token object represents an authentication token user in the Marketplace platform. The object contains the following properties:

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

Token's status. Possible values: Active, Disabled, or Deleted.

modules

Module validation when creating API Token.

account

The account under which the token has been defined.

Example:

token

string

The token's authentication code.

Example

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

Last updated

Was this helpful?