Soracom · Authentication Profile

Soracom Authentication

Authentication

Soracom secures its APIs with apiKey across 2 declared security schemes, as derived from its OpenAPI definitions.

IoTCellularLPWANSIMLoRaWANSigfoxMVNOConnectivityEdgeJapan
Methods: apiKey Schemes: 2 OAuth flows: API key in: header

Security Schemes

api_key apiKey
· in: header (X-Soracom-API-Key)
api_token apiKey
· in: header (X-Soracom-Token)

Source

Authentication Profile

Raw ↑ 
generated: '2026-07-11'
method: derived
source: openapi/soracom-analysis-query-api-openapi.yml, openapi/soracom-auth-api-openapi.yml,
  openapi/soracom-batch-api-openapi.yml, openapi/soracom-billing-api-openapi.yml, openapi/soracom-event-handler-api-openapi.yml,
  openapi/soracom-group-api-openapi.yml, openapi/soracom-harvest-api-openapi.yml, openapi/soracom-inventory-api-openapi.yml,
  openapi/soracom-lagoon-api-openapi.yml, openapi/soracom-lorawan-api-openapi.yml, openapi/soracom-napter-api-openapi.yml,
  openapi/soracom-platform-api-openapi.yml ...
summary:
  types:
  - apiKey
  api_key_in:
  - header
schemes:
- name: api_key
  type: apiKey
  in: header
  parameter: X-Soracom-API-Key
  description: |-
    API key for authentication. Obtain this from the Soracom User Console or via the Auth API.
    Required in combination with an API token for all authenticated requests.
  sources:
  - openapi/soracom-analysis-query-api-openapi.yml
  - openapi/soracom-auth-api-openapi.yml
  - openapi/soracom-batch-api-openapi.yml
  - openapi/soracom-billing-api-openapi.yml
  - openapi/soracom-event-handler-api-openapi.yml
  - openapi/soracom-group-api-openapi.yml
  - openapi/soracom-harvest-api-openapi.yml
  - openapi/soracom-inventory-api-openapi.yml
  - openapi/soracom-lagoon-api-openapi.yml
  - openapi/soracom-lorawan-api-openapi.yml
  - openapi/soracom-napter-api-openapi.yml
  - openapi/soracom-platform-api-openapi.yml
  - openapi/soracom-sigfox-api-openapi.yml
  - openapi/soracom-sim-api-openapi.yml
  - openapi/soracom-soracam-api-openapi.yml
  - openapi/soracom-stats-api-openapi.yml
  - openapi/soracom-vpg-api-openapi.yml
- name: api_token
  type: apiKey
  in: header
  parameter: X-Soracom-Token
  description: |-
    API token for authentication. This token has an expiration time and must be refreshed periodically.
    Required in combination with an API key for all authenticated requests.
  sources:
  - openapi/soracom-analysis-query-api-openapi.yml
  - openapi/soracom-auth-api-openapi.yml
  - openapi/soracom-batch-api-openapi.yml
  - openapi/soracom-billing-api-openapi.yml
  - openapi/soracom-event-handler-api-openapi.yml
  - openapi/soracom-group-api-openapi.yml
  - openapi/soracom-harvest-api-openapi.yml
  - openapi/soracom-inventory-api-openapi.yml
  - openapi/soracom-lagoon-api-openapi.yml
  - openapi/soracom-lorawan-api-openapi.yml
  - openapi/soracom-napter-api-openapi.yml
  - openapi/soracom-platform-api-openapi.yml
  - openapi/soracom-sigfox-api-openapi.yml
  - openapi/soracom-sim-api-openapi.yml
  - openapi/soracom-soracam-api-openapi.yml
  - openapi/soracom-stats-api-openapi.yml
  - openapi/soracom-vpg-api-openapi.yml