CustomerOS · Authentication Profile

Customeros Authentication

Authentication

CustomerOS secures its APIs with apiKey across 1 declared security scheme, as derived from its OpenAPI definitions.

CRMRevenueGo-To-MarketGraphQLOpen Source
Methods: apiKey Schemes: 1 OAuth flows: API key in: header

Security Schemes

ApiKeyAuth apiKey
· in: header (X-Openline-API-KEY)

Source

Authentication Profile

Raw ↑ 
generated: '2026-07-11'
method: derived
source: openapi/customeros-openapi.yml
summary:
  types:
  - apiKey
  api_key_in:
  - header
schemes:
- name: ApiKeyAuth
  type: apiKey
  in: header
  parameter: X-Openline-API-KEY
  description: Per-tenant API key. The open-source customer-os-api validates an API key header
    and resolves the tenant before applying @hasRole / @hasTenant directives. Header name and
    exact auth flow depend on deployment; the documented customeros.ai cloud REST surface uses
    X-CUSTOMER-OS-API-KEY.
  sources:
  - openapi/customeros-openapi.yml