PATCH
/scim/v2/Users/{userId}Partially update a SCIM user
Updates selected attributes of an existing SCIM user using patch operations. Supply the patch request in Operations and use userId to identify the user; use this operation when you do not want to replace the entire user resource.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
userIdintegerrequired
The integer identifier of the user to partially update.
SCIM PatchOp request data for partially updating a user; the request body is required.
Operationsarray<object>optional
An array of patch operations, with each operation defining an `op` and optional `path` and `value` data.
schemasarray<string>optional
SCIM patch schema identifiers; the defined value is `urn:ietf:params:scim:api:messages:2.0:PatchOp`.
200Returns the updated SCIM user resource, including its identifier, metadata, and user attributes.
idstringoptional
The unique identifier of the user.
metaobjectoptional
displayNamestringoptional
the display name of the user
emailsarray<object>optional
localestringoptional
Used to indicate the User's default location for purposes of localizing such items as currency, date time format, or numerical representations.
nameobjectoptional
photosarray<object>optional
The picture of the user. It is expected to have a single item in the context of Grist.
preferredLanguagestringoptional
Indicates the user's preferred written or spoken languages and is generally used for selecting a localized user interface.
schemasarray<string>optional
userNamestringoptional
The unique username.
400Returned when the patch request is invalid.
401Returned when the request is unauthenticated.
403Returned when the request is unauthorized.
404Returned when the user is not found.
409Returned when the update conflicts with an existing resource, such as an email address.
500Returned when an internal server error occurs.
Error handling
A 400 is returned when the patch request is invalid. A 401 is returned when the request is unauthenticated, and a 403 when it is unauthorized. A 404 indicates that the user was not found; a 409 indicates a resource conflict, such as a duplicate email. The userId path parameter is an integer, and a 500 indicates an internal server error.