Update a group with PATCH operations

PATCH

/scim/v2/directories/{directoryId}/Groups/{id}

SCIM 2.0 (RFC 7644 §3.5.2). Applies PATCH operations to the group, such as renaming it or adding and removing members, then reconciles the role assignments its mapping grants. Errors use SCIM's error schema (RFC 7644 §3.12).

Path Parameters

directoryIdstring Required

The directory the SCIM token was minted for.

idstring Required

Request body

application/json

schemasstring[] Required

OperationsScimPatchOperationDto[] Required

Responses

application/scim+json

schemasstring[]*
idstring*
externalIdstring
displayNamestring*
membersScimMemberDto[]*
metaScimMetaDto*

application/scim+json

schemasstring[]*
statusstring*
The HTTP status, as a string
detailstring*
scimTypestring
Present for some refusals, e.g. `uniqueness`

application/scim+json

schemasstring[]*
statusstring*
The HTTP status, as a string
detailstring*
scimTypestring
Present for some refusals, e.g. `uniqueness`

application/scim+json

schemasstring[]*
statusstring*
The HTTP status, as a string
detailstring*
scimTypestring
Present for some refusals, e.g. `uniqueness`

Returned object

ScimGroupDtoView all properties on this resource

Request

curl -X PATCH "https://auth.canopy-io.com/scim/v2/directories/value/Groups/value" \
  -H "Content-Type: application/json" \
  -d '{
    "schemas": [
      "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
      {
        "op": "add",
        "path": "string",
        "value": "string"
      }
    ]
  }'

Response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "string",
  "externalId": "string",
  "displayName": "string",
  "members": [
    {
      "value": "string"
    }
  ],
  "meta": {
    "resourceType": "User",
    "created": "2026-04-20T12:00:00.000Z",
    "lastModified": "2026-04-20T12:00:00.000Z",
    "location": "string",
    "version": "string"
  }
}

Was this page helpful?

Tell us how we can improve this guide.