user.delete

Descrição

object user.delete(array users)

Este método permite excluir 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. Consulte Funções do usuário para obter mais informações.

Parâmetros

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

Valores de retorno

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

Exemplos

Excluindo vários usuários

Excluir dois usuários.

Request:

{
    "jsonrpc": "2.0",
    "method": "user.delete",
    "params": [
        "1",
        "5"
    ],
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Response:

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

Fonte

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