Skip to main content
GET
Python

Authorizations

Authorization
string
header
required

Enter your JWT token

Response

The acting principal's identity.

Identity of the principal a Developer API request is authenticated as, returned by GET /v1/auth/whoami. For x-api-key requests the identity is the token's owner (the key acts as the owner) and UserType is "apiuser".

userType
string
required

Caller type: "apiuser" (x-api-key), "anonymous" (deleted profile), or "user".

fullName
string | null

The acting user's full name.

email
string | null

The acting user's email address.

currentCompany
string | null

Display name of the account/company the request is scoped to.

role
string | null

Role within the current company (e.g. "Admin", "Member").

workspace
object | null

The workspace an x-api-key key is pinned to. Null for a key created before keys were scoped (it spans the whole account) and for every caller that is not a key.

environment
object | null

The environment, of that workspace, an x-api-key key is pinned to. Null when the workspace is.

accessibleScopes
object[] | null

For a user token: the workspaces, each with its environments, that the token can open in the current company. These are the ones the user can open in the app, cut to the workspace/environment pairs an OAuth consent limited the token to, when it did. Empty when it can open none. Without a ceiling, a workspace the user holds with no environment is listed with environments: [] (it mirrors the app's switcher, but /v1 cannot act in it); under a ceiling it is dropped. Absent for an x-api-key request, whose scope is workspace and environment.