Read the current bootstrap admin role session.

Returns role and permission metadata for the presented bootstrap token without echoing the token. `admin` has full access, `operator` has a narrow operational write surface, and `viewer` is read-only.

GET /v1/admin/auth/session

Authentication

API Key (header: X-B3IQ-Admin-Token)

Responses

200 Bootstrap admin role context.

application/json

object string

Enum: b3iq.admin.auth_session

generated_at string (date-time)

role string

Enum: admin, operator, viewer

actor_type string

Enum: bootstrap_admin_token, bootstrap_operator_token, bootstrap_viewer_token

token_source string

Enum: authorization, x-b3iq-admin-token

permissions object

read boolean

operate boolean

administer boolean

allowed_actions string[]

Array of:

default B3IQ-native problem response.

curl -X GET 'https://{controlPlaneHost}/v1/admin/auth/session' \  -H 'X-B3IQ-Admin-Token: YOUR_API_KEY'

const response = await fetch('https://{controlPlaneHost}/v1/admin/auth/session', {  method: 'GET',  headers: {      "X-B3IQ-Admin-Token": "YOUR_API_KEY"  }});const data = await response.json();console.log(data);

200 Response

{  "object": "b3iq.admin.auth_session",  "generated_at": "2024-01-01T00:00:00Z",  "role": "admin",  "actor_type": "bootstrap_admin_token",  "token_source": "authorization",  "permissions": {    "read": true,    "operate": true,    "administer": true  },  "allowed_actions": [    "<string>"  ]}

default Response

{  "error": {    "status": 123,    "title": "<string>",    "detail": "<string>",    "code": "<string>"  }}

GET /v1/admin/auth/session

Base URL

Response

Was this page helpful?

Previous Export redacted customer ledger usage as JSON or CSV.

Next Review redacted admin command audit events.