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

Replace role memberships

Replaces the memberships of a SCIM role identified by roleId. Supply the complete members array because each request overwrites all existing memberships; properties other than memberships are ignored. Use PATCH /scim/v2/Roles/{roleId} to update only part of the membership.

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

SCIM role membership data. Replacing memberships overwrites the entire existing membership list; other properties are ignored.

membersarray<object>optional
The complete list of role members. Each member must include a `value` and `type`.
schemasarray<string>optional
The SCIM role schema identifier: `urn:ietf:params:scim:schemas:Grist:1.0:Role`.

6 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
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 401 is returned when the request is unauthenticated, and a 403 when it is unauthorized. 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; each members item must include value and type, and schemas must use the defined role schema identifier.