Options
All
  • Public
  • Public/Protected
  • All
Menu

Request the access token.

Hierarchy

Index

Properties

Optional accessToken

accessToken: string

Access token acquired from the user token.

Required for all requests except the initial request to acquire the access token.

Optional callerId

callerId: number

Client-tool determined value that is parroted back in the response.

Optional lifespan

lifespan: number

Specifies a brief lifespan for the issued access token (in seconds); Values longer than a short period are rejected, making this only useful for testing purposes; Zero yields the default lifespan (as does omitting the property)

refreshToken

refreshToken: string

User token for which to retrieve the access token.

toolName

toolName: string

Name that uniquely identifies the tool to the API (50 characters maximum); Must remain constant for the life of the tool (e.g. does not include version numbers or other details that will change)

Generated using TypeDoc