Apiary Authentication

generated: '2026-09-02'
method: searched
source: openapi/apiary-apiary-api-openapi.yml
docs: https://apiary.docs.apiary.io
docs_detail: >-
  Upgraded from derived to searched on 2026-09-02 after reading Apiary's own
  published authentication documentation: the Authentication and User Information
  resource-group descriptions in https://jsapi.apiary.io/apis/apiary (which cite
  RFC 6750 directly and give worked Basic-auth and Bearer curl examples), plus
  https://help.apiary.io/tools/apiary-cli/ for the APIARY_API_KEY environment
  variable and https://login.apiary.io/tokens for token issuance.
notes:
  - >-
    THE HEADER NAME IS NOT UNIFORM. /me and /me/apis take `Authorization: Bearer`;
    /blueprint/* takes `Authentication: Token` — a different header, same token
    value. Apiary calls the second one legacy.
  - >-
    Tokens are unscoped and account-wide. There are no OAuth scopes, no read-only
    tokens and no per-project tokens; Apiary documents the token as equivalent to a
    password.
  - >-
    The /authorization resource uses HTTP Basic with the account email and password,
    and does NOT work for users who are part of Oracle IDCS-controlled teams.
  - >-
    An invalid Bearer token is answered 401 with `WWW-Authenticate: Bearer
    error="invalid_token"` — RFC 6750 conformant challenge signalling.
  - No token expiry, refresh, rotation window or last-used metadata is published.
summary:
  types:
  - apiKey
  - http
  api_key_in:
  - header
schemes:
- name: basicAuth
  type: http
  scheme: basic
  description: HTTP Basic authentication with the Apiary account email and password. Used only
    on /authorization to mint, list and revoke tokens. Not available to users in IDCS-controlled
    teams.
  sources:
  - openapi/apiary-apiary-api-openapi.yml
- name: bearerAuth
  type: http
  scheme: bearer
  description: 'RFC 6750 Bearer token. Generate at https://login.apiary.io/tokens or via POST
    /authorization. Sent as `Authorization: Bearer <token>`.'
  sources:
  - openapi/apiary-apiary-api-openapi.yml
- name: legacyToken
  type: apiKey
  in: header
  parameter: Authentication
  description: 'Legacy Apiary token header, sent as `Authentication: Token <token>` (note: the
    header is `Authentication`, not `Authorization`). Apiary labels the /blueprint/* group legacy.
    This is the same token value the Apiary CLI reads from the APIARY_API_KEY environment variable.'
  sources:
  - openapi/apiary-apiary-api-openapi.yml