List IdP-pushed SCIM groups for the Environment

GET

/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/scim-groups

Lists the SCIM groups the IdP has provisioned into the current Environment, ordered by display name, each annotated with its current member_count and any existing role/node mapping (role_id, application_node_id). The response is an unpaginated { items } array.

Authentication

Bearer TokenAuthorization

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

Requires capability sso.viewSecurity

View SSO connections, domains, and directory sync. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Responses

application/json

itemsScimGroupResponseDto[]*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on.

403account.capability_requiredForbidden

When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

ScimGroupResponseDtoView all properties on this resource

Request

curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/scim-groups" \
  -H "Authorization: Bearer $CANOPY_TOKEN"

Response

{
  "items": [
    {
      "id": "string",
      "external_id": "string",
      "display_name": "string",
      "role_id": "string",
      "application_node_id": "string",
      "member_count": 0,
      "created_at": "2026-04-20T12:00:00.000Z"
    }
  ]
}

PUTMap a SCIM group to a role at a node
DELETEClear a SCIM group's role mapping

Was this page helpful?

Tell us how we can improve this guide.