{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/prep/sidebars.yaml","oas-products/prep/api/openapi.yaml":"oas-products/prep/api/openapi.yaml"},"props":{"metadata":{"markdoc":{"tagList":["split","openapi-code-sample"]},"type":"markdown"},"seo":{"title":"Authentication","description":"Hamilton's Developer Portal is used to help reference and understand the APIs of Hamilton products.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"authentication"},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Authenticate the session using the endpoints below. If user management is enabled, authentication is required for most API calls; do this initially to include the token in other requests."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"id":"51625554187","level":2},"children":["Authenticate "]},{"$$mdtype":"Tag","name":"Split","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send username and password to authenticate the session. Put the returned token in the authorization header of all other API requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Authorization: Bearer ","<","token",">"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/prep/api/openapi.yaml","operationId":"AuthenticateUser","parameters":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"id":"51625555339","level":2},"children":["Check authentication "]},{"$$mdtype":"Tag","name":"Split","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this endpoint to check if the authentication is valid. A ",{"$$mdtype":"Tag","name":"span","attributes":{"className":"value"},"children":["200"]}," response means the token is valid. "]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/prep/api/openapi.yaml","operationId":"CheckAuthentication","parameters":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"id":"51625556491","level":2},"children":["Renew authentication "]},{"$$mdtype":"Tag","name":"Split","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this endpoint to renew the authentication token."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/prep/api/openapi.yaml","operationId":"AuthenticateRenewToken","parameters":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"id":"51625557643","level":2},"children":["Logout "]},{"$$mdtype":"Tag","name":"Split","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this endpoint to end a session and invalidate the token."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"OpenApiCodeSample","attributes":{"descriptionFile":"oas-products/prep/api/openapi.yaml","operationId":"Logout","parameters":{},"environments":{}},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]}]},"headings":[{"value":"Authentication","id":"authentication","depth":1},{"value":"Authenticate","id":"51625554187","depth":2},{"value":"Check authentication","id":"51625555339","depth":2},{"value":"Renew authentication","id":"51625556491","depth":2},{"value":"Logout","id":"51625557643","depth":2}],"frontmatter":{"seo":{"title":"Authentication"}},"lastModified":"2026-07-30T19:22:04.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/pages/prep_recipe_authentication","userData":{"isAuthenticated":false,"teams":["anonymous"]}}