SCIM Patch User supported operations

SCIM Patch is very versatile and supports a higly flexible request syntax. Below guide provides list of attributes, operation and request format for SCIM Patch user operations supported by this endpoint.

warning

Only the attributes listed on this page, plus groups, can be changed with PATCH.

An operation on any other attribute is accepted and returns 200, but changes nothing — timezone, locale and userType behave this way. Set timezone with a full PUT instead. An operation on emails or profileUrl is rejected with 400.

Group membership is changed with groups add/remove operations, which are documented in Groups and their assignment to users.

Attribute: name.familyName, name.givenName:

name.givenName cannot be removed or set to an empty string — both are rejected with 400. Clear it with a full PUT instead. The remove example below applies to name.familyName only.

Operation: replace/add

{
  "op": "replace",
  "path": "name.familyName",
  "value": "newFamilyName"
}

Operation: remove

{
  "op": "remove",
  "path": "name.familyName"
}

Attribute: "nickName", "preferredLanguage"

Operation: replace/add

{
  "op": "replace",
  "path": "nickName",
  "value": "newNickName"
}

Operation: remove

{
  "op": "remove",
  "path": "nickName"
}

Attribute: "Addresses"

Operation: replace/add

{
  "op": "replace",
  "path": "addresses",
  "value": {
    "type": "work",
    "streetAddress": "100 Universal City Plaza",
    "locality": "Hollywood",
    "region": "US-IA",
    "postalCode": "91608",
    "country": "US",
    "formatted": "100 Universal City Plaza Hollywood, CA 91608 USA",
    "primary": true
  }
}

{
  "op": "replace",
  "path": "addresses.locality",
  "value":  "Hollywood"
}

Operation: remove

{
  "op": "remove",
  "path": "addresses[type eq \"work\"]"
}

{
  "op": "remove",
  "path": "addresses.locality"
}

Attribute: "phoneNumbers"

For Replace or Add

{
	"op":    "replace",
	"path":  "phoneNumbers[type eq \"mobile\"].value",
	"value": "tel:+91-9100000023"
}

For remove

{
	"op":    "remove",
	"path":  "phoneNumbers[type eq \"mobile\"].value"
}