1. Docs
  2. API Reference
  3. Get where an identity may act with one permission

Get where an identity may act with one permission

GET/api/v1/identities/{id}/accessible-nodes

Returns where the identity may act with permission, for a list query: roots, the nodes it holds the permission at that no other such node already covers, and nodes, every node beneath those roots, the roots included, when there are at most max_nodes of them (default 10,000; at most 50,000). Past the cap nodes is null and complete false, and the caller filters by roots against its own closure table or materialised path. env_wide is true when a root is the Environment's own root, so every node qualifies and no filter is needed; nodes is null then too. The same rules as evaluate decide the roots, so a list filtered by this answer agrees with the check a write makes. 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

Query Parameters

permissionstring Required

The permission to answer for, by key.

max length 200

max_nodesnumber Optional

The largest `nodes` set to return. Past it, `nodes` is null and `complete` false.

range 1–50000

Responses

application/json

  • dataIdentityAccessibleNodesResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

Request
curl -X GET "https://auth.canopy-io.com/api/v1/identities/value/accessible-nodes?permission=value&max_nodes=0" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "permission": "reports.view",
    "env_wide": false,
    "roots": [
      "string"
    ],
    "nodes": [
      "string"
    ],
    "complete": false
  }
}
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
POSTSet an identity's password (admin)
POSTForce a password reset for an identity (admin)
GETList an identity's active sessions (admin)
DELETERevoke one of an identity's sessions (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 identity's effective permissions
GETGet where an identity holds each permission
Was this page helpful?

Tell us how we can improve this guide.