Documentation menu

Auth reference

Public token endpoints: obtain and refresh access tokens.

POST/auth/login

Log in with email + password → tokens (incl. refresh token)

Request body object (required, application/json)

Responses

  • 200Token bundle.
  • 400Request body/params failed validation.
  • 401Missing/invalid token.
  • 429Rate limit exceeded.
  • 503An upstream dependency (e.g.
POST/auth/refresh

Exchange a refresh token for a new access token (no credentials)

Request body object (required, application/json)

Responses

  • 200New access/id token.
  • 400Request body/params failed validation.
  • 401Missing/invalid token.
  • 429Rate limit exceeded.
  • 503An upstream dependency (e.g.

TokenBundle schema

FieldTypeRequiredDescription
accessTokenstringoptionalAWS Cognito access token; send it on subsequent v2 requests as the `Authorization: Bearer <accessToken>` header.
idTokenstringoptionalAWS Cognito ID token carrying the authenticated user's identity claims.
refreshTokenstringoptionalAWS Cognito refresh token used to obtain new access tokens; returned by POST /auth/login but NOT by POST /auth/refresh (the original refresh token stays valid until it expires).
expiresInintegeroptionalLifetime of the access token in seconds, after which it must be refreshed.
tokenTypestringoptionalToken type for the Authorization header; always "Bearer".