Update a SCIM group

put/scim/v2/Groups/{groupId}

Updates a SCIM group. The displayName should be set by the client within the request body.

Request Samples

1

Response Samples

1{
2 "id": "e2c9c521-6b7c-49d2-8fff-7a3df8c03cf4",
3 "displayName": "TestScimGroup1-Replaced",
4 "externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159",
5 "members": [
6 {
7 "value": "2bca4a63-0892-484a-a9ef-aff7b7f0c795",
8 "ref": "https://localhost:8080/identities/scim/v2/Users/2bca4a63-0892-484a-a9ef-aff7b7f0c795",
9 "type": "User"
10 }
11 ],
12 "schemas": [
13 "urn:ietf:params:scim:schemas:core:2.0:Group"
14 ],
15 "meta": {
16 "resourceType": "Group",
17 "created": "2025-10-16T14:02:35.754Z",
18 "lastModified": "2025-10-16T14:02:35.766Z"
19 }
20}

Path Parameters

NameTypeRequiredDescription
groupId
string<object-id>
true

Unique identifier for the group resource (SCIM ID).

Header Parameters

NameTypeRequiredDescription
If-Match
string
false

The entity tag (ETag) value of the resource. If provided, the request succeeds only if the current resource version matches this value.

If-Unmodified-Since
string<date-time>
false

A date-time value. If provided, the request succeeds only if the resource has not been modified since the specified date.

Request Body

SCIM 2.0 Group resource for POST and PUT requests (group creation and updates). Note that id is server-generated and should not be included in requests.

NameTypeRequiredDescription
schemas
array [string]
true

SCIM schemas URN array.

id
string
false

Unique identifier for the group resource (SCIM ID).

<= 100 characters
displayName
string
true

A human-readable name for the group. This property is required.

<= 100 characters
Match pattern:
^(?!.*<[Ss][Cc][Rr][Ii][Pp][Tt][\s\S]*?>).*$
externalId
string
false

An identifier for the resource as defined by the provisioning client.

members
array [object]
false

A list of members of the group.

meta
object
false

Resource metadata.

undefined
false

Responses

StatusMeaningDescription
200OK

The group updated successfully.

Schema
400Bad Request

The request was invalid.

401Unauthorized

Authentication is required.

403Forbidden

The authenticated user does not have sufficient privileges.

Schema
404Not Found

The SCIM group could not be found.

Schema
412Precondition Failed

The If-Match or If-Unmodified-Since header condition was not met.