usergroup.update

Descrição

object usergroup.update(object/array userGroups)

Este método permite atualizar grupos de usuários existentes.

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

Parâmetros

(object/array) Propriedades do grupo de usuários a serem atualizadas.

A propriedade usrgrpid deve ser definida para cada grupo de usuários, todas as outras propriedades são opcionais. Apenas as propriedades passadas serão atualizadas, todas as outras permanecerão inalteradas.

Além das propriedades do grupo de usuários padrão, o método aceita os seguintes parâmetros.

Parâmetro	Tipo	Descrição
rights	object/array	Permissões para substituir as permissões atuais atribuídas ao grupo de usuários.
tag_filters	array	Permissões baseadas em etiquetas para atribuir ao grupo.
users	object/array	Usuários para adicionar ao grupo de usuários. O usuário deve ter a propriedade `userid` definida.

Valores de retorno

(object) Retorna um objeto contendo os IDs dos grupos de usuários atualizados sob a propriedade usrgrpids.

Exemplos

Desativando um grupo de usuários

Desabilitar um grupo de usuários.

Request:

{
           "jsonrpc": "2.0",
           "method": "usergroup.update",
           "params": {
               "usrgrpid": "17",
               "users_status": "1"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

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

Veja também

Permissão

Fonte

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

Documentation