OneRail · Authentication Profile

Onerail Authentication

Authentication

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

last-mile-deliverydelivery-orchestrationlogisticssupply-chainroute-optimizationcourier-networkshippingfleet-managementtransportationorder-managementwebhooksfinal-mile
Methods: apiKey, http, oauth2 Schemes: 5 OAuth flows: authorizationCode API key in: header

Security Schemes

ApiKey apiKey
· in: header (X-ONERAIL-API-KEY)
AppId apiKey
· in: header (X-ONERAIL-APP-ID)
ApiKeyAndAppId apiKey
· in: header (X-ONERAIL-API-KEY-AND-APP-ID)
bearer http
scheme: bearer
OAuth oauth2
· flows: authorizationCode

Source

Authentication Profile

Raw ↑ 
generated: '2026-08-02'
method: derived
source: openapi/onerail-delivery-api-openapi.yml, openapi/onerail-operations-api-openapi.yml
summary:
  types:
  - apiKey
  - http
  - oauth2
  api_key_in:
  - header
  oauth2_flows:
  - authorizationCode
schemes:
- name: ApiKey
  type: apiKey
  in: header
  parameter: X-ONERAIL-API-KEY
  sources:
  - openapi/onerail-delivery-api-openapi.yml
  - openapi/onerail-operations-api-openapi.yml
- name: AppId
  type: apiKey
  in: header
  parameter: X-ONERAIL-APP-ID
  sources:
  - openapi/onerail-delivery-api-openapi.yml
  - openapi/onerail-operations-api-openapi.yml
- name: ApiKeyAndAppId
  type: apiKey
  in: header
  parameter: X-ONERAIL-API-KEY-AND-APP-ID
  sources:
  - openapi/onerail-delivery-api-openapi.yml
- name: bearer
  type: http
  scheme: bearer
  description: |-
    Standard JWT bearer token used for authenticated OmniPoint users
    and internal service-to-service calls. Clients send `Authorization: Bearer <jwt>`
    and the token is validated using the shared Core access token secret.
  sources:
  - openapi/onerail-operations-api-openapi.yml
- name: OAuth
  type: oauth2
  flows:
  - flow: authorizationCode
    authorizationUrl: https://dummy-unused-url.com
    tokenUrl: https://dummy-unused-url.com
    scopes: 0
  description: |-
    OAuth 2.0 access token validated by the Operations service (e.g. Okta-backed
    integrations). Clients obtain tokens from their own IdP outside of this API
    and call endpoints with `Authorization: OAuth <access_token>`. The
    `authorizationUrl` and `tokenUrl` values below are placeholders only to
    satisfy the OpenAPI schema; this service does not call them directly and the
    real IdP URLs are configured vi
  sources:
  - openapi/onerail-operations-api-openapi.yml