Toast · Schema

AuthenticationRequest

Authentication credentials for your Toast API integration client software.

Food ServicePoint of SaleRestaurantsHospitality

Properties

Name Type Description
clientId string The identifier string for your Toast API client. You receive the identifier string from the Toast integrations team.
clientSecret string The secret string that corresponds to your Toast API client. You receive the secret string from the Toast integrations team.
userAccessType string Always include the `userAccessType` value and set it to `TOAST_MACHINE_CLIENT`.
View JSON Schema on GitHub

JSON Schema

authentication-authentication-request-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-schema/authentication-authentication-request-schema.json",
  "title": "AuthenticationRequest",
  "description": "Authentication credentials for your Toast API integration client software.\n",
  "type": "object",
  "properties": {
    "clientId": {
      "description": "The identifier string for your Toast API client. You receive the\nidentifier string from the Toast integrations team.\n",
      "type": "string",
      "example": "VKuhk4NaLedOcjZpJM8grvdrsFi3MlcM"
    },
    "clientSecret": {
      "description": "The secret string that corresponds to your Toast API client. You\nreceive the secret string from the Toast integrations team.\n",
      "type": "string",
      "example": "eS960aiKdvgbSDcLUCk68HR2CJKwwHNO2HKfgxjCWxoj27KIp6jFAi2XOOc_oCuv"
    },
    "userAccessType": {
      "description": "Always include the `userAccessType` value and set it to\n`TOAST_MACHINE_CLIENT`.\n",
      "type": "string",
      "example": "TOAST_MACHINE_CLIENT"
    }
  }
}