Toast · Schema

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.

RestaurantsPoint Of SalePaymentsOnline OrderingDeliveryLoyaltyGift CardsMenusOrdersKitchenLaborSchedulingInventoryHospitalityPartner Integrations

Properties

Name Type Description
tokenType string The OAuth 2 authentication scheme used for the authentication token. Toast API authentication uses the bearer authentication scheme.
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](https://dev.toasttab.com/doc/devg
expiresIn integer The number of seconds that the authentication token is valid.
accessToken string A JSON Web Token (JWT) string that contains an authentication token. You [present this string when you make requests](https://dev.toasttab.com/doc/devguide/authentication.html#using-authentication-tok
idToken string For internal use only.
refreshToken string For internal use only.
View JSON Schema on GitHub

JSON Schema

authentication-authentication-token-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast-tab/refs/heads/main/json-schema/authentication-authentication-token-schema.json",
  "title": "AuthenticationToken",
  "description": "Information about a Toast platform API session, including an\nauthentication token string that your Toast API client software can\npresent when using other Toast platform APIs.\n",
  "type": "object",
  "properties": {
    "tokenType": {
      "description": "The OAuth 2 authentication scheme used for the authentication token.\nToast API authentication uses the bearer authentication scheme.\n",
      "type": "string",
      "example": "Bearer"
    },
    "scope": {
      "description": "The scope value in the authentication token request response is\n`null`. The `accessToken` JSON Web Token (JWT) contains the list of\n[scopes for your Toast API\nclient](https://dev.toasttab.com/doc/devguide/apiScopes.html).\n",
      "type": "string",
      "example": "string"
    },
    "expiresIn": {
      "description": "The number of seconds that the authentication token is valid. \n",
      "type": "integer",
      "example": 86400
    },
    "accessToken": {
      "description": "A JSON Web Token (JWT) string that contains an authentication token.\nYou [present this string when you make\nrequests](https://dev.toasttab.com/doc/devguide/authentication.html#using-authentication-token)\nto other Toast API resources. The JWT includes information about your\nToast API client.\n",
      "type": "string",
      "example": "string"
    },
    "idToken": {
      "description": "For internal use only.\n",
      "type": "string",
      "example": "90a86f12"
    },
    "refreshToken": {
      "description": "For internal use only.\n",
      "type": "string",
      "example": "string"
    }
  }
}