Get current compute auth context

GET/compute/v1/auth/me

Returns the organization context available to the current API key or OAuth bearer token. OAuth callers can use X-Boltz-Organization-Id to select one of their organizations.

ReturnsExpand Collapse

AuthMeAPIKeyResponse = object { api_key_id, key_type, mode, 4 more }

api_key_id: string

key_type: "admin" or "workspace"

Accepts one of the following:

"admin"

"workspace"

mode: "live" or "test"

Accepts one of the following:

"live"

"test"

organization_id: string

principal_type: "api_key"

selected_organization_id: string

workspace_id: string

AuthMeUserResponse = object { active_organization_id, organization_memberships, principal_type, 2 more }

active_organization_id: string

organization_memberships: array of object { compute_role, organization_id }

compute_role: "admin" or "member"

Accepts one of the following:

"admin"

"member"

organization_id: string

principal_type: "user"

selected_organization_id: string

user_id: string

Get current compute auth context

curl https://api.boltz.bio/compute/v1/auth/me \
    -H "x-api-key: $BOLTZ_API_KEY"

{
  "api_key_id": "api_key_example",
  "key_type": "workspace",
  "mode": "live",
  "organization_id": "org_123",
  "principal_type": "api_key",
  "selected_organization_id": "org_123",
  "workspace_id": "ws_123"
}

Returns Examples

{
  "api_key_id": "api_key_example",
  "key_type": "workspace",
  "mode": "live",
  "organization_id": "org_123",
  "principal_type": "api_key",
  "selected_organization_id": "org_123",
  "workspace_id": "ws_123"
}