Clear a SCIM group's role mapping

DELETE

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

Clears a SCIM group's role/node mapping and reconciles, revoking the assignments this group owns — except where an overlapping group still justifies a member's role, in which case ownership is handed to that sibling rather than deleted. Attributed to the portal admin in an scim.group.unmapped audit row; responds 404 when the group is not found in the Environment and 204 with no body on success.

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

Responses

Removes the mapping and revokes the role from every member it was granted to

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.

Request

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

Response

HTTP/1.1 204 Removes the mapping and revokes the role from every member it was granted to

(empty body)

GETList IdP-pushed SCIM groups for the Environment
PUTMap a SCIM group to a role at a node

Was this page helpful?

Tell us how we can improve this guide.