Skip to content
Go to Boltz API

Auth

Inspect the authentication context for the current credential, including the organization or workspace scope for API keys and the available organization memberships for OAuth bearer tokens. OAuth callers can use this information to choose which organization to send with future requests.

Get current compute auth context
client.auth.me(RequestOptionsoptions?): AuthMeResponse
GET/compute/v1/auth/me
ModelsExpand Collapse
AuthMeResponse = AuthMeAPIKeyResponse { api_key_id, key_type, mode, 4 more } | AuthMeUserResponse { active_organization_id, organization_memberships, principal_type, 2 more }
One of the following:
AuthMeAPIKeyResponse { api_key_id, key_type, mode, 4 more }
api_key_id: string
key_type: "admin" | "workspace"
One of the following:
"admin"
"workspace"
mode: "live" | "test"
One of the following:
"live"
"test"
organization_id: string
principal_type: "api_key"
selected_organization_id: string
workspace_id: string | null
AuthMeUserResponse { active_organization_id, organization_memberships, principal_type, 2 more }
active_organization_id: string | null
organization_memberships: Array<OrganizationMembership>
compute_role: "admin" | "member"
One of the following:
"admin"
"member"
organization_id: string
principal_type: "user"
selected_organization_id: string | null
user_id: string