Get an authentication token

Returns an authentication token that your Toast API client can present when using other Toast platform APIs.

Authentication developer guide

Request

Request Body schema: application/json

The authentication credentials for your Toast API client integration software.

• 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.

Responses

200

A JSON AuthenticationResponse object that includes an authentication token string.

401

The Toast API client credentials in your request are not valid.

post /authentication/login

Request samples

application/json

{
  "clientId": "VKuhk4NaLedOcjZpJM8grvdrsFi3MlcM",
  "clientSecret": "eS960aiKdvgbSDcLUCk68HR2CJKwwHNO2HKfgxjCWxoj27KIp6jFAi2XOOc_oCuv",
  "userAccessType": "TOAST_MACHINE_CLIENT"
}

Response samples

application/json

{
  "token": {
    "tokenType": "Bearer",
    "scope": "string",
    "expiresIn": 86400,
    "accessToken": "string",
    "idToken": "string",
    "refreshToken": "string"
  },
  "status": "SUCCESS"
}