1. Docs
  2. API Reference
  3. List IdP-pushed SCIM groups for the Environment

List IdP-pushed SCIM groups for the Environment

GET/api/v1/scim-groups

Lists the SCIM groups the IdP has provisioned into the current Environment, one page at a time, ordered by display name unless sorted (sort_by name or created), each annotated with its current member_count and any existing role/node mapping (role_id, application_node_id). Searches display names and external ids with q.

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.

Requires permission sso.viewAccount

View SSO connections, verified domains and SCIM directories. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.

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 group display names and external ids

max length 200

sort_byenum Optional

Sort column. Defaults to `name`, A to Z.

one of "name" · "created"

orderenum Optional

Sort direction

one of "asc" · "desc"

Headers

  • X-Canopy-Environment

    The id of the Environment this request acts in. Required with an account API key, which belongs to the Account and names its Environment per request; an Environment key may send it only to name its own Environment. A missing header for an account key answers `400` (`api_key.environment_required`), one naming no Environment of the key's Account `400` (`api_key.environment_not_found`), and one naming another Environment than an Environment key's own `400` (`api_key.environment_mismatch`).

Responses

application/json

  • itemsScimGroupResponseDto[]*
  • paginationPageMetaDto*

application/json

  • errorApiErrorBodyDto*

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, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.

403authorization.deniedForbidden
When it happens

The credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.

Remediation

Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.

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

ScimGroupResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/scim-groups?page=0&take=0&q=value&sort_by=name&order=asc" \
  -H "X-Canopy-Environment: value" \
  -H "X-API-Key: $CANOPY_API_KEY"
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"
    }
  ],
  "pagination": {
    "page": 0,
    "take": 0,
    "item_count": 0,
    "page_count": 0,
    "has_previous_page": false,
    "has_next_page": false
  }
}
 Related endpoints
GETList active SCIM tokens for the Environment
POSTMint a SCIM bearer token for the Environment
GETRecent SCIM sync activity for the Environment
DELETERevoke a SCIM token
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.

Canopy