Breezeway Authentication

generated: '2026-10-03'
method: searched
generator: extract-docs-artifacts.py (local)
source: https://developer.breezeway.io/docs/authentication.md
sources:
- https://developer.breezeway.io/docs/authentication.md
- https://developer.breezeway.io/docs/authentication
- https://help.breezeway.io/en/articles/11426822-two-factor-authentication
- https://developer.breezeway.io/docs/obtaining-credentials.md
description: Breezeway uses JWT tokens obtained via a client‑credentials style POST to an auth endpoint. The access token is sent in the `Authorization`
  header prefixed with `JWT`.
schemes:
- type: http-bearer
  name: JWT
  evidence: To authenticate requests to the various Breezeway platform APIs, the access token must be provided in the request header `Authorization`
    and *must include* the scheme `JWT` as a prefix to the access token.
  location: header
  header: Authorization
  token_url: https://api.breezeway.io/public/auth/v1/
  how_to_obtain: Obtain a client id and client secret from the Breezeway credentials page, then POST them as JSON to the token URL to receive
    a JWT access token.
note: The documentation does not define standard OAuth2 flows, authorize URLs, or scopes; token acquisition is performed via a POST request with
  client credentials.
docs: https://developer.breezeway.io/docs/authentication.md