Skip to main content

Replace User

PUT 
/:namespace/Users/:id

Status: Trusted Tester

Replace a user's profile. The stored user is loaded, the profile attributes from the body are overlaid onto it, and the result is saved.

A profile attribute the body omits is cleared, as required by RFC 7644 §3.5.1. That covers name.givenName, name.familyName, nickName, preferredLanguage, timezone, addresses and phoneNumbers — and displayName with them, since it is derived from the two name parts. Send the complete profile on every PUT. PATCH changes one attribute without disturbing the others, but it does not accept every attribute in that list — see SCIM Patch User supported operations for the ones it does.

Roles and group membership are preserved. A PUT neither grants nor revokes access: platform features, business locations and business-feature access all survive unchanged, and a groups array in the body is ignored rather than applied. Partner users are replaced through the same path as business users.

userName and emails are not replaced. id comes from the URL, and the stored email is kept — a PUT cannot change a user's email address.

externalId is replaced, and omitting it clears it. It is taken from the body alone, so a PUT without an externalId blanks the stored mapping for this namespace. Send it on every PUT. This differs from PATCH, which leaves an untouched externalId alone.

Returns 404 when the id is not one of your users in {namespace}.

Request​

Responses​

OK