1. Docs
  2. API Reference
  3. Map a SCIM group to a role at a node

Map a SCIM group to a role at a node

PUT/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/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 portal admin in an scim.group.mapped audit row and returns the updated group with its member count.

Authentication

Bearer TokenAuthorization

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

Requires capability sso.manageSecurity

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

Path Parameters

idstring Required

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*

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 PUT "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/scim-groups/value/mapping" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -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"
  }
}
 Related endpoints
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.

Canopy