1. Docs
  2. API Reference
  3. Get Application identities summary

Get Application identities summary

GET/api/v1/identities/summary

Returns aggregate identity counts for the current Environment: total_identities (active memberships), assigned_count (identities holding at least one role assignment in this Environment), and unassigned_count. Intended for dashboard headers and onboarding checks rather than per-identity inspection.

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.

Responses

application/json

  • dataIdentitiesSummaryDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

IdentitiesSummaryDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/identities/summary" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "total_identities": 0,
    "assigned_count": 0,
    "unassigned_count": 0
  }
}
 Related endpoints
GETList identities in Application
POSTCreate an identity
GETList identities with their role assignments
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 identity's effective permissions
GETGet where an identity holds each permission
 Was this page helpful?

Tell us how we can improve this guide.

Canopy