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

Get App-wide assignment summary

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/assignments/app-wide/summary

Authentication

  • Bearer Token Authorization

    JWT access token

Code samples

cURLJavaScriptPythonGo
curl -X GET "https://api.canopy.dev/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/assignments/app-wide/summary" \
  -H "Authorization: Bearer $CANOPY_TOKEN"

Responses

200 Assignment status counts returned
{
  "active_count": 0,
  "scheduled_count": 0,
  "expired_count": 0,
  "expiring_soon_count": 0,
  "distinct_role_count": 0
}

application/json

  • active_countnumber*
  • scheduled_countnumber*
  • expired_countnumber*
  • expiring_soon_countnumber*
  • distinct_role_countnumber*
401 Invalid or expired token
403 This token is not authorized for this endpoint (wrong principal type — e.g., admin token on identity-only endpoint, or vice versa)

Returned object

On this page

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