Authentication matrix

The credential each IXO interface expects, who sets its access policy, and the header formats used in the docs, with rules for storing and rotating secrets.

This is the reference table of which credentials each IXO interface takes. IXO interfaces do not share one way to authenticate, so look up the row for the interface you are calling instead of applying one pattern everywhere.

For help choosing, read Choose how to authenticate to an IXO API.

Scope

  • Covers the authentication patterns that the IXO docs explicitly document.
  • Separates protocol gateways from service APIs.
  • Collects in one place the header examples used across guides and API pages.

Authentication by interface

InterfaceWho owns access policyDocumented patternHeader example
Blockchain RPC APINode / operator policyDeployment-specificConfirm per endpoint and operator policy
Blockchain REST API (gRPC gateway)Node / operator policyDeployment-specificConfirm per endpoint and operator policy
IXO Blocksync GraphQL APIService operator policyService-specific credential modelConfirm service deployment requirements
Matrix state bot APIService operator policyService-specific credential modelConfirm service deployment requirements
Registry APIService operator policyHistorical Basic auth exampleAuthorization: Basic <base64(username:password)>
Emerging Platform API (OpenAPI set)Service operator policyUnauthorized responses defined in schemaConfirm active header contract for deployment
USSD gateway APIDeployer / reverse proxyOften unauthenticated at app layer; restrict at network edgeNo default header. Use network controls in production.

Header formats used in the docs

Authorization: Bearer <token>
X-API-Key: <api_key>
Authorization: Basic <base64(username:password)>

Where to get credentials

  • Protocol gateways: get the access policy from the operator of your target node or network.
  • Service APIs: get credentials from the service operator for the environment you use.
  • Confirm endpoint and environment mappings in Networks and endpoints.

Secret management

PracticeWhat to do
Environment variablesLoad API keys, Basic passwords, Matrix tokens and database URLs from the environment or a secrets manager. Never commit them to git or embed them in client-side bundles.
RotationWhen operators rotate credentials, update your deployment config first, then redeploy clients. Prefer short-lived tokens where the service supports them.
Least privilegeUse separate credentials per environment (dev/staging/prod) and per integration, so a leak does not span systems.
LogsStrip authorization headers and tokens from application logs and exception reports.