Patch a Group

Applies SCIM PatchOp operations to Group metadata. Supported paths are displayName, externalId, and description. Removing description clears it. Changing displayName does not change externalId. The id, schemas, and meta attributes are read-only and cannot be patched. Group membership is unsupported. Unsupported paths, including members, return 400 with scimType invalidPath. The All Users Group Code cannot be changed. Without a projection query the response is 204; with attributes or excludedAttributes it is 200 with the resulting Group representation. Projected Group responses always include id and schemas and never include members.

Path Params
uuid
required
Query Params
string

Comma-separated attributes to include. Sending this with excludedAttributes returns 400 with scimType invalidValue.

string

Comma-separated attributes to exclude. Sending this with attributes returns 400 with scimType invalidValue.

Body Params

An ordered SCIM 2.0 patch request.

schemas
array of strings
required
length ≥ 1

SCIM schema identifiers. Must include urn:ietf:params:scim:api:messages:2.0:PatchOp.

schemas*
Allowed:
Operations
array of objects
required
length ≥ 1

Operations to apply in order.

Operations*
Responses

204

Group updated without a projection response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/scim+json