Skip to content
CantoraAPI documentation
GET
/v1/identity

Describe the authenticated caller

Return the authenticated Principal and the Control Plane deployment serving the request.

Authentication

Send an API key as a Bearer token in the Authorization header.

Parameters

This operation has no path or query parameters.

Responses

200Success
application/json
Any of
OrganizationMemberIdentityEncoded
UserIdentityEncoded
ServicePrincipalIdentityEncoded
AgentIdentityEncoded
401Unauthorized
application/json
UnauthorizedEncoded

Reusable schemas

OrganizationMemberIdentityEncoded

object
  • unknown properties allowed false
principalIdrequired
stringThe Principal identifier.
  • maximum length 64
  • pattern ^principal_[\s\S]+$
serviceVersionrequired
stringThe immutable version of the serving Control Plane revision.
environmentNamerequired
stringThe deployment this container is part of, which is not a Cantora Environment
kindrequired
stringThe authenticated Principal kind.
  • allowed values "organizationMember"
organizationIdrequired
stringThe Organization identifier.
  • maximum length 64
  • pattern ^org_[\s\S]+$
organizationNamerequired
stringThe customer-facing Organization name.
displayNamerequired
stringThe human-readable resource name.
emailAddressrequired
stringThe Organization Member's email address.
organizationRolerequired
The caller's active Organization-wide role, or null when no such Grant is active.
Any of
string
  • allowed values "owner", "admin", "developer", "viewer"
null

UserIdentityEncoded

object
  • unknown properties allowed false
principalIdrequired
stringThe Principal identifier.
  • maximum length 64
  • pattern ^principal_[\s\S]+$
serviceVersionrequired
stringThe immutable version of the serving Control Plane revision.
environmentNamerequired
stringThe deployment this container is part of, which is not a Cantora Environment
kindrequired
stringThe authenticated Principal kind.
  • allowed values "user"

ServicePrincipalIdentityEncoded

object
  • unknown properties allowed false
principalIdrequired
stringThe Principal identifier.
  • maximum length 64
  • pattern ^principal_[\s\S]+$
serviceVersionrequired
stringThe immutable version of the serving Control Plane revision.
environmentNamerequired
stringThe deployment this container is part of, which is not a Cantora Environment
kindrequired
stringThe authenticated Principal kind.
  • allowed values "servicePrincipal"

AgentIdentityEncoded

object
  • unknown properties allowed false
principalIdrequired
stringThe Principal identifier.
  • maximum length 64
  • pattern ^principal_[\s\S]+$
serviceVersionrequired
stringThe immutable version of the serving Control Plane revision.
environmentNamerequired
stringThe deployment this container is part of, which is not a Cantora Environment
kindrequired
stringThe authenticated Principal kind.
  • allowed values "agent"

UnauthorizedEncoded

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Unauthorized"
reasonrequired
stringA safe explanation of why the credential was rejected.