Grist Octri Preview
PUT/scim/v2/Groups/{groupId}

Replace a SCIM group

Replaces a group's information with the supplied SCIM group data. Include the complete information you want the group to have; use PATCH when you want to change only selected properties.

1 parameter · 3 body fields
groupIdintegerrequired
The identifier of the group to replace.

Complete SCIM group data to replace the group's information.

displayNamestringoptional
The display name of the group.
membersarray<object>optional
The group members; each member must include a `value` and a `type`.
schemasarray<string>optional
The SCIM schema identifier for a group: `urn:ietf:params:scim:schemas:core:2.0:Group`.

6 status codes
200Returns the replaced group object, including its identifier, display name, members, metadata, and schema identifier.
displayNamestringoptional
The name of the group.
idstringoptional
The unique identifier of the group.
membersarray<object>optional
metaobjectoptional
schemasarray<string>optional
401Returned when the request is unauthenticated.
403Returned when the request is unauthorized.
404Returned when the group is not found.
409Returned when the group update conflicts with an existing resource, such as through a conflicting display name.
500Returned when an internal server error occurs.

Error handling

A 401 is returned when the request is unauthenticated, and a 403 is returned when it is unauthorized. A 404 means the groupId path parameter was not found; a 409 indicates a resource conflict, such as a conflicting displayName. A 500 indicates an internal server error. Each supplied member must include value and type, and schemas must contain the SCIM Group schema identifier.