API Referenceauth

Get authenticated API key actor

View as Markdown
Return the API key actor for the current request. Use this to validate CLI credentials and show whether the key is scoped to an organization or subaccount.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Headers

BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Response

OK
defaultSpaceIdstring or null
effectiveScopeobject
emailstring or nullformat: "email"
keyIdstring or null
organizationIdstring
planenum
scopeenum
subaccountIdstring or null1-64 characters
Opaque identifier for a BCTRL subaccount.

Errors

401
Unauthorized Error
403
Forbidden Error