v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB

User groups

Update user group

Update the specified user group by applying a list of SCIM 2.0 patch operations. Use PATCH to add or remove individual members, or to rename the group, without affecting other attributes.

To replace the entire group resource (including the full membership list) in a single request, use the Replace user group endpoint.

patch/scim/v2/groups/{userGroupId}

Path parameters

userGroupIdstring required

The ID of the group to be updated

Request body

schemasstring[] required

The SCIM schema URIs for the request. Must include urn:ietf:params:scim:api:messages:2.0:PatchOp.

Operation	Description
add with path: "members"	Add one or more users to the group
remove with path: 'members[value eq "{userId}"]'	Remove a single user from the group
replace with path: "displayName"	Rename the group
replace with path: "members"	Replace the entire membership list
replace without a path	Replace top-level attributes (for example, displayName)

Example request

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "path": "members"
    }
  ]
}

Response

Group updated successfully

idstring

Unique identifier for the group

displayNamestring

The name of the group

schemasstring[]

SCIM schema information for the group

Example response

{
  "meta": {
    "resourceType": "Group"
  }
}