usergroup.delete

Descrição

object usergroup.delete(array userGroupIds)

Este método permite excluir grupos de usuários.

O grupo de usuários Desprovisioned (o grupo de usuários especificado para disabled_usrgrpid em Authentication) não pode ser excluído.

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 de usuário. Consulte Funções de usuário para mais informações.

Parâmetros

(array) IDs dos grupos de usuários a serem excluídos.

Valores de retorno

(object) Retorna um objeto contendo os IDs dos grupos de usuários excluídos na propriedade usrgrpids.

Exemplos

Excluindo vários grupos de usuários

Exclua dois grupos de usuários.

Requisição:

{
           "jsonrpc": "2.0",
           "method": "usergroup.delete",
           "params": [
               "20",
               "21"
           ],
           "id": 1
       }

Resposta:

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

Origem

CUserGroup::delete() em ui/include/classes/api/services/CUserGroup.php.

Documentation