Get identity's effective permissions
/api/v1/identities/{id}/permissionsReturns the identity's effective permission keys for the current Environment as a flat items array of strings. Without node_id, the Application-wide answer: every permission its role assignments grant anywhere. With node_id, the answer at that node: the permissions granted by assignments on the node's lineage, the list a screen renders its controls from. Returns 404 when the identity has no membership in this Environment, or when node_id names no node in it.
Authentication
Authorization Option A JWT access token. Never send alongside X-API-Key: a request carrying both is refused.
X-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 Query Parameters
node_idstring · uuid Optional Answer at this node: the permissions granted by assignments on its lineage. Omit for the Application-wide answer.
Responses
application/json
itemsstring[]
application/json
errorApiErrorBodyDto
application/json
errorApiErrorBodyDto
application/json
errorApiErrorBodyDto
application/json
errorApiErrorBodyDto
curl -X GET "https://auth.canopy-io.com/api/v1/identities/value/permissions?node_id=value" \ -H "X-API-Key: $CANOPY_API_KEY"
{ "items": [ "string" ] }
Tell us how we can improve this guide.