Modify a user's attributes in Cloud Directory. It can be used to update one or more attributes.

Entitlement required: manageUserGroups (Manage users and groups), or manageAllUserGroups (Synchronize users and groups), or manageUserStandardGroups (Manage users and standard groups), or updateAnyUser (Update any user).
Note: You only need one entitlement, but you can have more than one.

Only certain attributes for federated users can be modified unless you have the manageAllUserGroups entitlement. The user's groups cannot be modified and are ignored in the payload. Group membership is managed by using the PUT /v2.0/Groups/{id} and PATCH /v2.0/Groups/{id} API.

By default, an email is sent to regular users that includes the changed attributes. Federated users do not get an email notification. The email template for branding is at "notifications/user_management/profile/{locale}/user_profile_modified_email.xml". Pass in the themeId query parameter to brand the email template for notifications.

The following is an example of a patch request that adds a title, replaces the formatted name, and removes any custom attributes which name contains "customA" from the user. Notice also that the example shows how you can specify the notifyType if you want to.
NotifyType is an optional attribute that denotes the notification type. If not present, the EMAIL notification is used.Specify NONE if no notification is required.

{ "schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations": [ { "op":"add", "path":"title", "value":"Vice President" }, { "op":"replace", "path":"name.formatted", "value":"James Smith-Miller" }, { "op":"remove", "path":"urn:ietf:params:scim:schemas:extension:ibm:2.0:User:customAttributes[name co "customA"]" }, { "op": "add", "path": "urn:ietf:params:scim:schemas:extension:ibm:2.0:Notification:notifyType", "value": "EMAIL" } ]}

Language
URL