API Client Bearer Token object representation

The bearertoken object representation and fields are described below.

bearertoken was introduced in API version V1

bearertoken has not been marked for deprecation

Endpoint usages

Bearer Token

Description

Representation of a bearer token used to authenticate an API request

Example create representation

{
  "urn" : "eea7299a-d10c-47c5-be79-599b40812861",
  "apiClient" : {
    "urn" : "3d059a42-2095-4d19-aea9-3243787e1ccd"
  },
  "expirationTimestamp" : "2026-09-02T00:36:32.093"
}

Example response representation

{
  "urn" : "eea7299a-d10c-47c5-be79-599b40812861",
  "apiClient" : {
    "urn" : "3d059a42-2095-4d19-aea9-3243787e1ccd"
  },
  "bearerToken" : "9uMNdP...",
  "expirationTimestamp" : "2026-09-02T00:36:32.093"
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	The URN of the bearer token
apiClient	API Client		Required on create. Ignored on update.
bearerToken	String literal	Bearer token generated on create for a client
expirationTimestamp	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.	The expiration timestamp of the token if set.