usergroup.delete

Descrição

object usergroup.delete(array userGroupIds)

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

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 (user roles). Consulte Funções do usuário para obter 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 sob a propriedade usrgrpids.

Exemplos

Excluindo vários grupos de usuários

Excluir dois grupos de usuários.

Request:

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

Response:

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

Fonte

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