user.update

This method allows to update existing users.

This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See for more information.

The strength of user password is validated according the password policy rules defined by Authentication API. See Authentication API for more information.

Parameters

(object/array) User properties to be updated.

Additionally to the standard user properties, the method accepts the following parameters.

(object) Returns an object containing the IDs of the updated users under the property.

Examples

Renaming a user

Rename a user to John Doe.

Request:

Changing user role

Change a role of a user.

Request:

Response:

Source

CUser::update() in ui/include/classes/api/services/CUser.php.