1. Docs
  2. API Reference
  3. List an identity's responsibilities within the caller's scope

List an identity's responsibilities within the caller's scope

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/workspace/identities/{identityId}/assignments

One page of the role assignments an identity holds in the Environment, as far as the caller can see them, oldest first unless sorted (sort_by role, node or created); searches role and node names with q. Requires workspace_identity.view somewhere in the Environment. An Environment-wide caller sees all of the identity's assignments, and gets an empty page for an identity that holds none. A node-scoped caller sees only assignments at nodes in their subtree and gets 404 when none are visible, so an identity outside their branches is never confirmed to exist.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

identityIdstring Required

Query Parameters

pagenumber Optional

Page number (1-based)

min 1

takenumber Optional

Items per page (1-100, default 20)

range 1–100

qstring Optional

Search role and node names

max length 200

sort_byenum Optional

Sort column. Defaults to `created`, oldest first.

one of "role" · "node" · "created"

orderenum Optional

Sort direction

one of "asc" · "desc"

Responses

application/json

  • itemsWorkspaceIdentityAssignmentDto[]*
  • paginationPageMetaDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Pagination

This endpoint returns a paginated collection. Use the query parameters below to page through results.

pagenumber

Page number (1-indexed). Defaults to 1.

takenumber

Items per page (1 to 100). Defaults to 20.

Each response includes an items array alongside a pagination object with item_count, page_count, has_previous_page, and has_next_page fields.

Returned object

WorkspaceIdentityAssignmentDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/workspace/identities/value/assignments?page=0&take=0&q=value&sort_by=role&order=asc" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "id": "string",
      "role": {
        "id": "string",
        "name": "string"
      },
      "application_node_id": "string",
      "effective_from": "2026-04-20T12:00:00.000Z",
      "effective_to": "2026-04-20T12:00:00.000Z",
      "created_at": "2026-04-20T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 0,
    "take": 0,
    "item_count": 0,
    "page_count": 0,
    "has_previous_page": false,
    "has_next_page": false
  }
}
 Related endpoints
GETResolve the caller's operational authority in the Environment
GETList identities within the caller's operational scope
GETList the identity roles the caller may grant
GETList the hierarchy locations the caller may assign at
GETList the hierarchy nodes the caller can see in this Environment
GETList identity invitations within the caller's scope
POSTInvite an identity into a location with a role
GETList scoped operational activity within the caller's scope
GETDownload the scoped activity feed as CSV
GETHow long activity history is kept for this Account
POSTResend a scoped invitation
DELETERevoke a scoped invitation
POSTGrant an identity a role at a hierarchy node
PATCHMove or re-role an existing assignment
DELETERemove an identity's role assignment
 Was this page helpful?

Tell us how we can improve this guide.

Canopy