Skip to main content
POST
Error

Authorizations

​
Authorization
string
header
required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Path Parameters

​
organizationId
string
required

The workspace identifier.

Body

application/json
​
scopes
enum<string>[]

Custom requested scopes. The server adds the minimum baseline and rejects any scope outside the immutable login ceiling.

Available options:
scans:read,
scans:write,
vulnerabilities:read,
vulnerabilities:write,
dependencies:read,
schedules:read,
schedules:write,
assets:read,
assets:write,
organizations:read,
organizations:write,
members:read,
members:write,
invitations:read,
invitations:write,
webhooks:read,
webhooks:write,
tokens:write,
audit:read,
pr_reviews:read,
pr_reviews:write,
connectors:read,
connectors:write,
knowledge:read,
knowledge:write,
uploads:write,
integrations:read,
integrations:write,
chat:read,
chat:write,
scans:message,
analytics:read,
llm:read,
llm:write,
test_users:read,
test_users:write,
license:read,
supply_chain:read,
supply_chain:write,
billing:read,
billing:write
​
scope_profile
enum<string>

Named CLI authority preference. Minimal grants scans and billing:read. Recommended adds every scope that everyday strix cloud commands use: vulnerabilities, dependencies, supply chain, schedules, assets, knowledge, PR reviews, connectors, chat, uploads, integrations, analytics, license, webhooks:read, audit:read, organizations:read, organizations:write, and billing:write. Full means the session's approved ceiling after login and adds account administration (members, invitations, tokens, webhooks:write, LLM, test users). Custom requires an explicit scopes array. The member's role caps every profile.

Available options:
minimal,
recommended,
full,
custom
​
client_instance_id
string

Optional device identity used only to upgrade a legacy CLI credential. Must be sent with device_name.

Required string length: 8 - 128
​
device_name
string

Human-readable name of the device that holds the credential, for example Alex MacBook.

Required string length: 1 - 80

Response

The same token, switched to the selected workspace.

​
api_token
string
required
​
organization_id
string
required
​
organization_name
string
required
​
scopes
enum<string>[]
required
Available options:
scans:read,
scans:write,
vulnerabilities:read,
vulnerabilities:write,
dependencies:read,
schedules:read,
schedules:write,
assets:read,
assets:write,
organizations:read,
organizations:write,
members:read,
members:write,
invitations:read,
invitations:write,
webhooks:read,
webhooks:write,
tokens:write,
audit:read,
pr_reviews:read,
pr_reviews:write,
connectors:read,
connectors:write,
knowledge:read,
knowledge:write,
uploads:write,
integrations:read,
integrations:write,
chat:read,
chat:write,
scans:message,
analytics:read,
llm:read,
llm:write,
test_users:read,
test_users:write,
license:read,
supply_chain:read,
supply_chain:write,
billing:read,
billing:write
​
scope_ceiling
enum<string>[]
required
Available options:
scans:read,
scans:write,
vulnerabilities:read,
vulnerabilities:write,
dependencies:read,
schedules:read,
schedules:write,
assets:read,
assets:write,
organizations:read,
organizations:write,
members:read,
members:write,
invitations:read,
invitations:write,
webhooks:read,
webhooks:write,
tokens:write,
audit:read,
pr_reviews:read,
pr_reviews:write,
connectors:read,
connectors:write,
knowledge:read,
knowledge:write,
uploads:write,
integrations:read,
integrations:write,
chat:read,
chat:write,
scans:message,
analytics:read,
llm:read,
llm:write,
test_users:read,
test_users:write,
license:read,
supply_chain:read,
supply_chain:write,
billing:read,
billing:write
​
requested_scopes
enum<string>[]
required
Available options:
scans:read,
scans:write,
vulnerabilities:read,
vulnerabilities:write,
dependencies:read,
schedules:read,
schedules:write,
assets:read,
assets:write,
organizations:read,
organizations:write,
members:read,
members:write,
invitations:read,
invitations:write,
webhooks:read,
webhooks:write,
tokens:write,
audit:read,
pr_reviews:read,
pr_reviews:write,
connectors:read,
connectors:write,
knowledge:read,
knowledge:write,
uploads:write,
integrations:read,
integrations:write,
chat:read,
chat:write,
scans:message,
analytics:read,
llm:read,
llm:write,
test_users:read,
test_users:write,
license:read,
supply_chain:read,
supply_chain:write,
billing:read,
billing:write
​
scope_profile
enum<string>
required

Named CLI authority preference. Minimal grants scans and billing:read. Recommended adds every scope that everyday strix cloud commands use: vulnerabilities, dependencies, supply chain, schedules, assets, knowledge, PR reviews, connectors, chat, uploads, integrations, analytics, license, webhooks:read, audit:read, organizations:read, organizations:write, and billing:write. Full means the session's approved ceiling after login and adds account administration (members, invitations, tokens, webhooks:write, LLM, test users). Custom requires an explicit scopes array. The member's role caps every profile.

Available options:
minimal,
recommended,
full,
custom
​
token_id
string<uuid>
required
​
credential_source
enum<string>
required
Available options:
api,
cli
​
email
string
​
expires_at
string<date-time> | null
​
device_name
string | null