[comment]: # translation:outdated

[comment]: # ({9d4a1084-9d4a1084})
# usergroup.update

[comment]: # ({/9d4a1084-9d4a1084})

[comment]: # ({5a75f4fe-9fdfde6c})
### Descrição
  
`object usergroup.update(object/array userGroups)`
  
Este método permite atualizar grupos de usuários existentes.
  
::: noteclassic  
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](/manual/web_interface/frontend_sections/administration/user_roles) para obter mais informações.
:::

[comment]: # ({/5a75f4fe-9fdfde6c})

[comment]: # ({6c062363-93a5d635})
### 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](object#user_group), o método aceita os seguintes parâmetros.  
  
|Parâmetro|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|rights|object/array|[Permissões](/manual/api/reference/usergroup/object#permission) para substituir as permissões atuais atribuídas ao grupo de usuários.|  
|tag\_filters|array|[Permissões baseadas em etiquetas](/manual/api/reference/usergroup/object#tag_based_permission) para atribuir ao grupo.|  
|users|object/array|[Usuários](/manual/api/reference/user/create) para adicionar ao grupo de usuários.<br><br>O usuário deve ter a propriedade `userid` definida.|

[comment]: # ({/6c062363-93a5d635})

[comment]: # ({c04afd7f-c04afd7f})
### Valores de retorno
  
`(object)` Retorna um objeto contendo os IDs dos grupos de usuários atualizados sob a propriedade `usrgrpids`.

[comment]: # ({/c04afd7f-c04afd7f})

[comment]: # ({b41637d2-b41637d2})
### Exemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({e268fa14-e1a75e7b})
#### Desativando um grupo de usuários
  
Desabilitar um grupo de usuários.

Request:

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

Response:

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

[comment]: # ({/e268fa14-e1a75e7b})

[comment]: # ({d5c7ed4f-d5c7ed4f})
### Veja também
  
- [Permissão](object#permission)

[comment]: # ({/d5c7ed4f-d5c7ed4f})

[comment]: # ({09e213c5-09e213c5})
### Fonte

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

[comment]: # ({/09e213c5-09e213c5})