Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Reference

Request reference:

PropertyDescription
lifetimeSeconds

Lifetime in seconds for the access token.

Set this value to -1 to create a non-expiring token.

descriptionUser-friendly description of the token


Response reference:

PropertyDescription
tokenValue

The token itself.

Info

NOTE: This value must be retained and provided with each subsequent request for the user.


tokenInfo.tokenId

Internal identifier for the token.

Info

NOTE: This value is unique within this instance of the platform. When performing requests on a specific token, its tokenId must be provided as the object identifier.


tokenInfo.descriptionUser-friendly description for the access token
tokenInfo.expiredAt

Timestamp for when the access token expires.

null value indicates that the access token never expires.

tokenInfo.lastUsed

Timestamp for when the access token was last used.

null value indicates that the access token has never been used.

tokenInfo.createdAtTimestamp for when the access token was created