1. Docs
  2. API Reference
  3. Get identity summary for a node

Get identity summary for a node

GET/api/v1/nodes/{id}/identities/summary

Returns aggregate identity-assignment counts for a node, gated by hierarchy.view. Computed across the node's lineage so both direct and inherited assignments are reflected: direct_count, inherited_count, status breakdown (active_count, scheduled_count, expired_count, expiring_soon_count), distinct_role_count, a sample of the five most recent identities, and can_manage_assignments (whether the caller also holds hierarchy.manage here). Returns 404 when the node is not found 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

  • dataNodeIdentitiesSummaryDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

NodeIdentitiesSummaryDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/nodes/value/identities/summary" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "direct_count": 0,
    "inherited_count": 0,
    "can_manage_assignments": false,
    "active_count": 0,
    "scheduled_count": 0,
    "expired_count": 0,
    "expiring_soon_count": 0,
    "distinct_role_count": 0,
    "recent_identities": [
      {
        "id": "string",
        "first_name": "string",
        "last_name": "string",
        "name": "string",
        "avatar_url": "string"
      }
    ]
  }
}
 Related endpoints
GETList hierarchy (scoped tree)
POSTCreate a hierarchy node
GETList the hierarchy as parent edges
GETGet a hierarchy node
PATCHUpdate a hierarchy node
DELETEDelete a hierarchy node
GETGet subtree from a node
GETGet ancestor chain for a node
GETGet direct children of a node
POSTMove (reparent) a node
GETList identities at a node
 Was this page helpful?

Tell us how we can improve this guide.

Canopy