Skip to content
Boltz Boltz Boltz API Docs
Go to Boltz API
API Reference
Auth

Get current compute auth context

auth.me() -> AuthMeResponse
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
Accepts one of the following:
class AuthMeAPIKeyResponse: …
api_key_id: str
key_type: Literal["admin", "workspace"]
Accepts one of the following:
"admin"
"workspace"
mode: Literal["live", "test"]
Accepts one of the following:
"live"
"test"
organization_id: str
principal_type: Literal["api_key"]
selected_organization_id: str
workspace_id: Optional[str]
class AuthMeUserResponse: …
active_organization_id: Optional[str]
organization_memberships: List[AuthMeUserResponseOrganizationMembership]
compute_role: Literal["admin", "member"]
Accepts one of the following:
"admin"
"member"
organization_id: str
principal_type: Literal["user"]
selected_organization_id: Optional[str]
user_id: str

Get current compute auth context

import os
from boltz_api import Boltz

client = Boltz(
    api_key=os.environ.get("BOLTZ_API_KEY"),  # This is the default and can be omitted
)
response = client.auth.me()
print(response)
{
  "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"
}