AuthenticationToken

Information about a Toast platform API session, including an authentication token string that your Toast API client software can present when using other Toast platform APIs.

accessToken
string

A JSON Web Token (JWT) string that contains an authentication token. You present this string when you make requests to other Toast API resources. The JWT includes information about your Toast API client.

expiresIn
integer

The number of seconds that the authentication token is valid.

idToken
string

For internal use only.

refreshToken
string

For internal use only.

scope
string

The scope value in the authentication token request response is null. The accessToken JSON Web Token (JWT) contains the list of scopes for your Toast API client.

tokenType
string

The OAuth 2 authentication scheme used for the authentication token. Toast API authentication uses the bearer authentication scheme.

{
  • "tokenType": "Bearer",
  • "scope": "string",
  • "expiresIn": 86400,
  • "accessToken": "string",
  • "idToken": "string",
  • "refreshToken": "string"
}