Grist Octri Preview
PATCH/scim/v2/Roles/{roleId}

Update role memberships

Updates the memberships of a SCIM role by applying patch operations. Supply the operations in the request body; properties other than memberships are ignored.

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

1 parameter · 2 body fields
roleIdintegerrequired
The integer identifier of the role whose memberships to update.

SCIM patch data for updating role memberships. Only memberships can be modified; other properties are ignored.

Operationsarray<object>optional
Patch operations to apply to the role, with operation, path, and value fields.
schemasarray<string>optional
The SCIM patch schema identifier: `urn:ietf:params:scim:api:messages:2.0:PatchOp`.

7 status codes
200Returns the updated SCIM role object, including its display name, memberships, metadata, and schemas.
displayNamestringoptional
The name of the role.
idstringoptional
The unique identifier of the role.
membersarray<object>optional
metaobjectoptional
schemasarray<string>optional
400Returned when the request is invalid.
401Returned when the request is unauthenticated.
403Returned when the request is unauthorized.
404Returned when the role is not found.
409Returned when the update conflicts with a resource, such as the role's display name.
500Returned when an internal server error occurs.

Error handling

A 400 is returned for a bad request; a 401 indicates an unauthenticated request, and a 403 indicates an unauthorized request. A 404 is returned when the role is not found, a 409 when the update conflicts with a resource such as displayName, and a 500 when an internal server error occurs. The roleId path parameter must identify an existing role; properties other than memberships are ignored.