Skip to main content
The Orion API uses OAuth2 password flow for authentication. You’ll exchange your username and password for an access token, then include that token in subsequent API requests.

​
Authentication Flow

1

Request an access token

Call the login endpoint with your credentials to receive an access token.
curl -X POST '/v1alpha/auth/login' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'username=YOUR_USERNAME&password=YOUR_PASSWORD'
2

Store the token

The response includes an access token. Store it securely for use in subsequent requests.
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer"
}
3

Include token in requests

Add the token to the Authorization header of all authenticated API requests:
Authorization: Bearer YOUR_ACCESS_TOKEN

​
Available Scopes

When authenticating, you can request specific permission scopes:
ScopeDescription
adminFull administrative access to all features
analystCreate and manage analysis jobs
data_heroExtended data access permissions
viewerRead-only access to results and insights

​
Endpoints

Login

Authenticate with username and password to obtain an access token.

Token Authentication

Alternative token endpoint for OAuth2 compatibility.
Access tokens have an expiration time. If you receive a 401 Unauthorized response, request a new token using the login endpoint.