Grist Octri Preview
PUT/scim/v2/Users/{userId}

Replace a SCIM user resource

Replaces a user's SCIM resource with the supplied user data. Provide the attributes for the replacement in the request body; omitted attributes are overwritten rather than preserved. Use PATCH /scim/v2/Users/{userId} when you want to update only selected attributes.

1 parameter · 8 body fields
userIdintegerrequired
The integer identifier of the user whose resource to replace.

SCIM user resource data that replaces the user's information; the request body is required.

displayNamestringoptional
the display name of the user
emailsarray<object>optional
Email addresses for the user, each with a value and an optional primary indicator.
localestringoptional
Used to indicate the User's default location for purposes of localizing such items as currency, date time format, or numerical representations.
nameobjectoptional
The user's name, with a formatted value for the full name.
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
SCIM schema identifiers; the defined user schema is `urn:ietf:params:scim:schemas:core:2.0:User`.
userNamestringoptional
The unique username.

6 status codes
200Returns the replaced 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.
401Returned when the request is unauthenticated.
403Returned when the request is unauthorized.
404Returned when the user is not found.
409Returned when the replacement conflicts with an existing resource, such as an email address.
500Returned when an internal server error occurs.

Error handling

A 401 is returned when the request is unauthenticated. A 403 is returned when the request is unauthorized, and a 404 when the user is not found. A 409 indicates a resource conflict, such as a duplicate emails value; the userId path parameter is an integer. A 500 indicates an internal server error.