user.update

Descrição

object user.update(object/array users)

Este método permite atualizar usuários existentes.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.

A força da senha do usuário é validada de acordo com as regras de política de senha definidas pela API de Autenticação. Veja API de Autenticação 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, o método aceita os seguintes parâmetros.

Parâmetro	Tipo	Descrição
current_passwd	string	Senha atual do usuário. O valor deste parâmetro pode ser uma string vazia se o usuário estiver vinculado a um diretório de usuários. Comportamento do parâmetro: - somente escrita - obrigatório se `passwd` do objeto Usuário estiver definido e o usuário alterar sua própria senha
usrgrps	array	Grupos de usuários para substituir os grupos de usuários existentes. Os grupos de usuários devem ter apenas a propriedade `usrgrpid` definida.
medias	array	Mídias do usuário para substituir as mídias existentes não provisionadas. As mídias provisionadas podem ser omitidas ao atualizar as mídias.

Valores de retorno

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

Exemplos

Renomeando um usuário

Renomeie um usuário para John Doe.

Requisição:

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

Resposta:

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

Alterando a função do usuário

Altere a função de um usuário.