1. Docs
  2. API Reference
  3. Get App-wide assignment summary

Get App-wide assignment summary

GET/api/v1/assignments/app-wide/summary

Returns aggregate assignment counts for the active Application within the current Environment: active_count, scheduled_count, expired_count, expiring_soon_count, and distinct_role_count. Counts cover all direct assignments in the Environment, not just the current page, and are intended for summary stat cards. Requires the rbac.view_assignments permission.

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

  • dataAssignmentsSummaryDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

AssignmentsSummaryDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/assignments/app-wide/summary" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "active_count": 0,
    "scheduled_count": 0,
    "expired_count": 0,
    "expiring_soon_count": 0,
    "distinct_role_count": 0
  }
}
 Related endpoints
GETList all assignments across the Application
POSTAssign a role to an identity at a node
PATCHUpdate an assignment
DELETERemove an assignment
POSTBulk remove assignments
POSTBulk change role on assignments
POSTBulk-create role assignments. All-or-nothing: any failure rolls back the entire batch
 Was this page helpful?

Tell us how we can improve this guide.

Canopy