v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
SCIM

Update user

Partially updates a user's attributes using SCIM PATCH operations (RFC 7644 Section 3.5.2).

Only the replace operation is supported. Supported target paths:

  • active
  • externalId
  • userName
  • name.givenName
  • name.familyName
  • name (complex object)
  • emails (complex array)
  • emails[type eq "work"].value

When path is omitted, the value must be an object whose fields are merged into the user resource.

Returns 204 No Content on success.

patch/scim/Users/{userUid}

Path parameters

userUidstring required

Phrase Platform identity UID of the user

Request body

schemasstring[]

SCIM schema URNs

Example request

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}

Response

User updated successfully — no content returned