Skip to navigation
API ReferenceAuthentication

Get Current API Key Context

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-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
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 headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

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

Errors

401
Unauthorized Error
403
Forbidden Error