1. Docs
  2. API Reference
  3. Get an Environment's custom token claims

Get an Environment's custom token claims

GET/api/v1/token-claims

Returns the custom claims the Environment adds to its identity tokens: for each, the claim's name, the stored fact it is read from (source) and the tokens it goes on (access, id), in the order they are added, with the Environment's version to send back as If-Match. An empty list means no custom claims.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Requires permission token_claims.viewAuthentication

View the custom claims the Environment adds to its tokens. A scoped API key must hold it as a scope; a full-access key is unrestricted within its Environment; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.

Responses

application/json

  • dataTokenClaimsResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.

403authorization.deniedForbidden
When it happens

The credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.

Remediation

Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.

Returned object

TokenClaimsResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/token-claims" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "version": 0,
    "claims": [
      {
        "claim": "plan",
        "source": "identity.metadata.plan",
        "tokens": [
          "access",
          "id"
        ]
      }
    ]
  }
}
 Related endpoints
PUTReplace an Environment's custom token claims
 Was this page helpful?

Tell us how we can improve this guide.

Canopy