{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/authentication/tag/Data-definitions/schema/ErrorMessage/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/authentication/tag/Data-definitions/schema/ErrorMessage/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.0.0\",\"title\":\"Toast authentication API\",\"description\":\"The authentication API returns an authentication token that you can present\\nwhen your integration client software uses other Toast APIs. For more\\ninformation about authentication, see [the Toast Developer\\nGuide](https://doc.toasttab.com/doc/devguide/authentication.html).\\n\",\"termsOfService\":\"https://pos.toasttab.com/api-terms-of-use\",\"contact\":{\"name\":\"Toast developer support\"}},\"tags\":[{\"name\":\"Authentication\"}],\"externalDocs\":{\"description\":\"Authentication developer guide\",\"url\":\"https://doc.toasttab.com/doc/devguide/authentication.html\"},\"paths\":{\"/authentication/login\":{\"post\":{\"tags\":[\"Authentication\"],\"summary\":\"Get an authentication token\",\"description\":\"Returns an authentication token that your Toast API client can present\\nwhen using other Toast platform APIs.\\n\",\"externalDocs\":{\"description\":\"Authentication developer guide\",\"url\":\"https://doc.toasttab.com/doc/devguide/authentication.html\"},\"operationId\":\"authenticationLoginPost\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AuthenticationRequest\"}}},\"description\":\"The authentication credentials for your Toast API client integration\\nsoftware.\\n\",\"required\":true},\"responses\":{\"200\":{\"description\":\"A JSON `AuthenticationResponse` object that includes an\\nauthentication token string.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/AuthenticationResponse\"}}}},\"401\":{\"description\":\"The Toast API client credentials in your request are not valid.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}}}}}}}},\"servers\":[{\"url\":\"https://toast-api-server/authentication/v1\"}],\"components\":{\"schemas\":{\"AuthenticationRequest\":{\"type\":\"object\",\"description\":\"Authentication credentials for your Toast API integration client software.\\n\",\"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\"}}},\"AuthenticationResponse\":{\"type\":\"object\",\"description\":\"A wrapper object for the response to a successful Toast API authentication\\nrequest.\\n\",\"properties\":{\"token\":{\"$ref\":\"#/components/schemas/AuthenticationToken\"},\"status\":{\"description\":\"The value `SUCCESS` indicates that your authentication request was successful.\",\"type\":\"string\",\"example\":\"SUCCESS\"}}},\"AuthenticationToken\":{\"type\":\"object\",\"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\",\"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\"},\"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\"},\"idToken\":{\"description\":\"For internal use only.\\n\",\"type\":\"string\"},\"refreshToken\":{\"description\":\"For internal use only.\\n\",\"type\":\"string\"}}},\"ErrorMessage\":{\"type\":\"object\",\"description\":\"An object that contains information about one or more errors that the\\nToast platform encountered when processing your API request.\\n\",\"properties\":{\"status\":{\"description\":\"The HTTP status code of the response.\\n\",\"type\":\"string\"},\"code\":{\"description\":\"A numeric identifier for the error condition.\\n\",\"type\":\"integer\"},\"message\":{\"description\":\"A description of the error condition.\\n\",\"type\":\"string\"},\"messageKey\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\"},\"fieldName\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\"},\"link\":{\"description\":\"The URL of a resource that provides more information about the error\\ncondition.\\n\",\"type\":\"string\"},\"requestId\":{\"description\":\"The unique identifier of the HTTP request that your client sent to the Toast API.\\n\",\"type\":\"string\"},\"developerMessage\":{\"description\":\"Additional detail about the error condition, if it is available.\\n\",\"type\":\"string\"},\"errors\":{\"description\":\"A JSON array of `ErrorMessage` objects.\\n\",\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ErrorMessage\"}},\"canRetry\":{\"description\":\"Reserved for future use.\\n\",\"type\":\"string\"}}}}}}},\"options\":{\"hideTryItPanel\":true,\"pagination\":\"item\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"}]},\"showConsole\":false,\"hideHostname\":true,\"hideDownloadButton\":true,\"sortPropsAlphabetically\":true,\"schemaDefinitionsTagName\":\"Data definitions\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/authentication/overview/","redocItemId":"tag/Data-definitions/schema/ErrorMessage","redocHasInfoPage":false,"settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Java"},{"lang":"Python"}]},"showConsole":false,"hideHostname":true,"hideDownloadButton":true,"sortPropsAlphabetically":true,"schemaDefinitionsTagName":"Data definitions","hideTryItPanel":true},"requestLogin":false,"lastModified":"2023-01-20T04:29:51.000Z"},"seo":{"title":"ErrorMessage"}}},"pageContext":{"id":"a2648787-a3d2-5d12-886f-8dd09ca5cd80tag/Data-definitions/schema/ErrorMessage/__redocly content/authentication/tag/Data-definitions/schema/ErrorMessage/","seo":{"title":"ErrorMessage","description":"<SchemaDefinition showWriteOnly={true} schemaRef=\"#/components/schemas/ErrorMessage\" />","image":"","keywords":null,"jsonLd":null,"lang":null},"pageId":"authentication.reference.page.yaml#tag/Data-definitions/schema/ErrorMessage/","pageBaseUrl":"/authentication","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/authentication/tag/Data-definitions/schema/ErrorMessage/","sidebarName":"api-reference","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"authentication","id":"authentication","title":"authentication","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1180902673","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3743992808","561138138"]}