Skip to main content

CreateUserTokenResponse

idstringnullable

Token ID

Example: 9fkgh6
namestringnullable

Token name

createdAtstring<date-time>required

Token creation date and time

Example: 2022-12-21T10:01:11.123
expiresIninteger<int32>required

Token validity period in seconds

Example: 3600
expiresAtstring<date-time>required

Token expiry date and time

Example: 2022-12-21T10:01:11.123
isRevokedbooleanrequired

If the value is true, the token has been revoked

isExpiredbooleanrequired

If the value is true, the token has expired

isValidbooleanrequired

If the value is true, the token is valid

The token is not valid if it is either revoked or expired. Only valid tokens can be used to access the API.

scopestringrequired

Scopes, delimited with space

Possible values: non-empty

Example: partner:create user:create
lastUsedAtstring<date-time>nullable

Date and time when the token was last used

Example: 2023-04-21T10:01:11.123
revokedAtstring<date-time>nullable

Date and time when the token was revoked

Example: 2023-04-21T10:01:11.123
accessTokenstringrequired

Access token

Possible values: non-empty

Example: zxMbx_TgwdYF1hgOVb8M5YOvxOukqfjzYOGRZcJiCjQuRGkVIBfjjV1HF5zKTGiY2aPn2cQTGaQOT8uo5uo7_QOXts1s5TREuRHc6a8X30RrGBTyqV9h26KJHcLKJbZ
CreateUserTokenResponse
{
"id": "9fkgh6",
"name": "string",
"createdAt": "2022-12-21T10:01:11.123",
"expiresIn": 3600,
"expiresAt": "2022-12-21T10:01:11.123",
"isRevoked": true,
"isExpired": true,
"isValid": true,
"scope": "partner:create user:create",
"lastUsedAt": "2023-04-21T10:01:11.123",
"revokedAt": "2023-04-21T10:01:11.123",
"accessToken": "zxMbx_TgwdYF1hgOVb8M5YOvxOukqfjzYOGRZcJiCjQuRGkVIBfjjV1HF5zKTGiY2aPn2cQTGaQOT8uo5uo7_QOXts1s5TREuRHc6a8X30RrGBTyqV9h26KJHcLKJbZ"
}