Skip to content
EntitlerDocs

GET/v1/caller

Describe the calling key

Returns the key whose credential is in Authorization, with its scope and permissions. It takes a key credential, not an access token.

curl 'https://api.entitler.co/v1/caller' \
  -H "Authorization: Bearer $ENTITLER_KEY"

Credentials

Send any one of these:

  • Bearer token

Responses

200The DescribeCallerResponse message.

DescribeCallerResponse

  • keyKey
    • allowedOriginsarray of stringrequired
    • createdAtintegerrequired

      at least 0; at most 18446744073709552000

    • environmentKindEnvironmentKindrequired

      One of ENVIRONMENT_KIND_UNSPECIFIED, ENVIRONMENT_KIND_TEST, ENVIRONMENT_KIND_LIVE.

    • expiresAtinteger

      at least 0; at most 18446744073709552000

    • exposureKeyExposurerequired

      One of KEY_EXPOSURE_UNSPECIFIED, KEY_EXPOSURE_SECRET, KEY_EXPOSURE_PUBLISHABLE.

    • idstringrequired
    • namestringrequired
    • permissionsarray of Permissionrequired
    • revisionintegerrequired

      at least 0; at most 18446744073709552000

    • scopeKeyScope
      • environmentEnvironmentKeyScope
        • environmentIdstringrequired
        • projectIdstringrequired
      • projectProjectKeyScope
        • projectIdstringrequired
      • teamTeamKeyScope
    • teamIdstringrequired
    • updatedAtintegerrequired

      at least 0; at most 18446744073709552000

    • versionintegerrequired

      at least 0; at most 18446744073709552000

ErrorA refusal, with the HTTP status of its gRPC code.

Error

  • errorobjectrequired
    • codestringrequired
    • parametersobjectrequired

      Each value: string

    • reasonstringor nullrequired