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

200Identity
application/json
IdentityJsonEncoding
401Unauthorized
application/json
UnauthorizedJsonEncoding

Reusable schemas

IdentityJsonEncoding

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

UnauthorizedJsonEncoding

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.