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.

Parâmetros

(object/array) Propriedades do usuário a serem atualizadas.

A propriedade userid deve ser definida para cada usuário, todas as outras propriedades são opcionais. Somente as propriedades passadas serão atualizadas, todas as outras permanecerão inalteradas.

Além das propriedades padrão do usuário standard user properties, o método aceita os seguintes parâmetros.

Parâmetro	Tipo	Descrição
passwd	string	Senha do usuário. Pode ser uma string vazia se o usuário pertencer ou for movido apenas para grupos que têm acesso LDAP.
usrgrps	array	Grupos de usuários groups para substituir os grupos de usuário existentes. Os grupos de usuários devem ter a propriedade `usrgrpid` definida.
medias	array	User media para substituir a mídia existente.
user_medias (obsoleto)	array	Este parâmetro está obsoleto, por favor use `medias` . Usuário media para substituir a mídia existente.

Valores de retorno

(object) Retorna um objeto contendo IDs dos usuários atualizados na propriedade userids .

Exemplos

Renomeando um usuário

Renomeie um usuário para John Doe.

Request:

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

Resposta:

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

Alterando o papel do usuário

Altere um papel de um usuário.

Requisição:

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

Resposta:

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

Consulte também

Authentication

Fonte

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

Documentation