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

AuthMeResponse = AuthMeAPIKeyResponse { api_key_id, key_type, mode, 4 more } | AuthMeUserResponse { active_organization_id, organization_memberships, principal_type, 2 more }

Accepts one of the following:

AuthMeAPIKeyResponse { api_key_id, key_type, mode, 4 more }

api_key_id: string

key_type: "admin" | "workspace"

Accepts one of the following:

"admin"

"workspace"

mode: "live" | "test"

Accepts 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"

Accepts one of the following:

"admin"

"member"

organization_id: string

principal_type: "user"

selected_organization_id: string | null

user_id: string

Get current compute auth context

import Boltz from 'boltz-api';

const client = new Boltz({
  apiKey: process.env['BOLTZ_API_KEY'], // This is the default and can be omitted
});

const response = await client.auth.me();

console.log(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"
}