Esta é uma tradução da página de documentação original em inglês. Ajude-nos a torná-la melhor.

user.update

###Descrição

object user.update(object/array users)

Esse método permite atualizar usuários existentes.

Esse método está disponível para usuários de qualquer tipo. Permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Ver User roles para mais informações.

A força da senha do usuário é validada de acordo com as regras da política de senhas definidas pela API de Autenticação. Ver Authentication API para mais informações.

Parameters

(object/array) User properties to be updated.

The userid property must be defined for each user, all other properties are optional. Only the passed properties will be updated, all others will remain unchanged.

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

Parameter Type Description
passwd string User's password.

Can be empty string if user belongs to or is moved only to groups that have LDAP access.
usrgrps array User groups to replace existing user groups.

The user groups must have the usrgrpid property defined.
medias array User media to replace existing media.

Return values

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

Exemplos

Renaming a user

Rename a user to John Doe.

Request:

{
           "jsonrpc": "2.0",
           "method": "user.update",
           "params": {
               "userid": "1",
               "name": "John",
               "surname": "Doe"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "userids": [
                   "1"
               ]
           },
           "id": 1
       }

Changing user role

Change a role of a user.

Request:

{
           "jsonrpc": "2.0",
           "method": "user.update",
           "params": {
               "userid": "12",
               "roleid": "6"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "userids": [
                   "12"
               ]
           },
           "id": 1
       }

See also

Fonte

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