Shorebird · Authentication Profile

Shorebird Authentication

Authentication

Shorebird secures its APIs with oauth2 and apiKey across 3 declared security schemes, as derived from its OpenAPI definitions. OAuth 2.0 is offered via the authorizationCode flow(s).

CompanyCloud SaasFlutterCode PushOTA UpdatesMobileMobile AppsDeploymentCI/CDDevOps
Methods: oauth2, apiKey Schemes: 3 OAuth flows: authorizationCode API key in: environment-variable

Security Schemes

console-oauth oauth2
SHOREBIRD_TOKEN apiKey
· in: env ()
api-key apiKey
· in: header ()

Source

Authentication Profile

shorebird-authentication.yml Raw ↑ 
generated: '2026-07-21'
method: searched
source: https://docs.shorebird.dev/account/api-keys/
docs: https://docs.shorebird.dev/account/
summary:
  types: [oauth2, apiKey]
  api_key_in: [environment-variable]
  oauth2_flows: [authorizationCode]
  note: >-
    Shorebird has no public REST OpenAPI; authentication is documented for the
    CLI and console rather than declared in a spec. Interactive users
    authenticate to the console via OAuth; CI and machine access use tokens /
    API keys carried in the SHOREBIRD_TOKEN environment variable.
schemes:
- name: console-oauth
  type: oauth2
  flow: authorizationCode
  description: >-
    Interactive sign-in to console.shorebird.dev and `shorebird login`, backed
    by federated identity providers (Google / GitHub / Microsoft).
  sources: [https://console.shorebird.dev/login]
- name: ci-token
  type: apiKey
  in: env
  name: SHOREBIRD_TOKEN
  description: >-
    A machine token generated by `shorebird login:ci`, exported as the
    SHOREBIRD_TOKEN environment variable for non-interactive CI use.
  sources: [https://docs.shorebird.dev/ci/]
- name: api-key
  type: apiKey
  in: header
  description: >-
    Account-scoped API keys created in the console (Account > API keys) for
    programmatic access.
  sources: [https://docs.shorebird.dev/account/api-keys/]