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

Partially update a SCIM group

Updates selected properties of a group using SCIM patch operations. Supply the operations in Operations and use the SCIM PatchOp schema identifier in schemas.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
groupIdintegerrequired
The identifier of the group to update.

SCIM patch request containing the operations to apply and the PatchOp schema identifier.

Operationsarray<object>optional
The SCIM patch operations to apply; operation entries can include `op`, `path`, and `value`.
schemasarray<string>optional
The SCIM patch schema identifier: `urn:ietf:params:scim:api:messages:2.0:PatchOp`.

7 status codes
200Returns the updated 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
400Returned when the patch request is invalid.
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 400 is returned when the patch request is invalid; schemas must contain urn:ietf:params:scim:api:messages:2.0:PatchOp. 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 display name. A 500 indicates an internal server error.