ApiToken

ApiToken
ApiToken

API token that facilitates API-based access

JSON Example
{
    "accessTokenTtl": 0,
    "apiClientId": "string",
    "apiTokenTtl": 0,
    "creationDate": 0,
    "expirationDate": 0,
    "id": "string",
    "lastUsedDate": 0,
    "oidcIssuerUrl": "string",
    "principalName": "string",
    "principalStatus": "string",
    "token": "string",
    "tokenDescription": "string",
    "tokenEndpointUrl": "string",
    "tokenLastChars": "string",
    "tokenName": "string",
    "tokenStatus": "string",
    "tokenType": "string"
}
integer As int32 As int32
accessTokenTtl
Optional

Time-To-Live lifespan in minutes of the access tokens that are generated from this API token

string
apiClientId
Optional

Client ID of the API client with which this API token is associated

integer As int32 As int32
apiTokenTtl
Optional

Time-To-Live lifespan in minutes of the API token

integer As int64 As int64
creationDate
Optional

The date on which the API token was created

integer As int64 As int64
expirationDate
Optional

The date on which the API token expires

string As uuid As uuid
id
Optional

Unique ID for API token in identity broker

integer As int64 As int64
lastUsedDate
Optional

The date on which the API token was last exchanged for a bearer token

string
oidcIssuerUrl
Optional

The OIDC issuer URL

string
principalName
Optional

The name of the principal for which this token was generated: UPN for users and client ID for API clients

string
principalStatus
Optional

Principal active / inactive status

Possible values are : ACTIVE, INACTIVE, UNKNOWN,
string
token
Optional

Full API token string that callers can use to obtain bearer access tokens

string
tokenDescription
Optional

Optional description of the API token

string
tokenEndpointUrl
Optional

The token endpoint URL

string
tokenLastChars
Optional

Sub string containing the last few characters of the full token string

string
tokenName
Required

User-friendly display name of the API token

string
tokenStatus
Optional

API token active / expired status

Possible values are : ACTIVE, EXPIRED, UNKNOWN,
string
tokenType
Optional

API token client / user type

Possible values are : API_CLIENT, USER, UNKNOWN,
Property Of
Parameter To
Returned By