Map a SCIM group to a role at a node

PUT

/api/v1/scim-groups/{id}/mapping

Maps an IdP-pushed SCIM group to a Canopy role_id at a placement application_node_id, then reconciles role assignments for every current member — granting the role to members that lack it (tagged with the group as source). The role and node must exist in the Environment, and system roles are rejected (400); responds 404 when the group, role, or node is not found. Attributed to the caller in an scim.group.mapped audit row and returns the updated group with its member count.

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.manageAccount

Create, update, and delete SSO connections, verified domains and SCIM tokens. 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.

Path Parameters

idstring Required

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`).

Request body

application/json

role_idstring Required

The Canopy role to grant members of this group.

application_node_idstring Required

The hierarchy node the role is assigned at.

Responses

application/json

dataScimGroupResponseDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

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.

Returned object

ScimGroupResponseDtoView all properties on this resource

Request

curl -X PUT "https://auth.canopy-io.com/api/v1/scim-groups/value/mapping" \
  -H "X-Canopy-Environment: value" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "role_id": "string",
    "application_node_id": "string"
  }'

Response

{
  "data": {
    "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"
  }
}

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
GETList IdP-pushed SCIM groups for the Environment
DELETEClear a SCIM group's role mapping

Was this page helpful?

Tell us how we can improve this guide.