1. Docs
  2. API Reference
  3. Get identity's effective permissions

Get identity's effective permissions

GET/api/v1/identities/{id}/permissions

Returns the identity's effective Application-wide permission keys for the current Environment as a flat items array of strings, resolved across all of its role assignments. Use this to answer "what can this identity do" without replaying individual assignments. Returns 404 when the identity has no membership in this Environment.

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.

Path Parameters

idstring Required

Responses

application/json

  • itemsstring[]*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*
Request
curl -X GET "https://auth.canopy-io.com/api/v1/identities/value/permissions" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "items": [
    "string"
  ]
}
 Related endpoints
GETList identities in Application
POSTCreate an identity
GETList identities with their role assignments
GETGet Application identities summary
POSTBulk-create identities
GETGet an identity
PATCHUpdate an identity
DELETERemove an identity
GETGet identity detail with role assignments
POSTActivate an identity
POSTDeactivate an identity
POSTSet an identity's password (admin)
POSTForce a password reset for an identity (admin)
POSTRevoke all of an identity's sessions (admin)
GETGet MFA enrollment summary for an identity
POSTForce-reset an identity's MFA — admin recovery action
GETRead an identity's auth state for backend decisioning
POSTMark an identity's email verified (admin)
GETGet identity's role assignments
GETGet where an identity holds each permission
 Was this page helpful?

Tell us how we can improve this guide.

Canopy