Skip to main content
POST
Error

Body

application/json
selection_token
string
required

Selection token from POST /cli/login/poll with interactive set to true.

organization_id
string

Workspace that receives the token. Without this field, the server uses the user's first workspace.

scopes
enum<string>[]

Scopes the user selected. The server always includes the minimum scopes scans:read, scans:write, and billing:read. The member's role limits the final set.

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. Full means the session's approved ceiling after login; custom requires an explicit scopes array.

Available options:
minimal,
recommended,
full,
custom

Response

Sign-in complete. The api_token field contains the raw secret — store it securely.

api_token
string
required

Raw personal API token secret. Only returned at sign-in time.

organization_id
string
required
organization_name
string
required
email
string
required
expires_at
string<date-time>
required

Expiry of the API token.

is_new_user
boolean
required

True when this sign-in created the account.

scopes
enum<string>[]
required

Scopes granted to the minted token.

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

Maximum authority approved for this session at login.

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. Full means the session's approved ceiling after login; custom requires an explicit scopes array.

Available options:
minimal,
recommended,
full,
custom
token_id
string<uuid>
required
credential_source
enum<string>
required
Available options:
api,
cli
device_name
string | null