user.delete

Описание

object user.delete(array users)

Этот метод позволяет удалять пользователей.

Этот метод доступен только для типа пользователя Супер-администратор. Разрешения на вызов метода можно отозвать в настройках роли пользователя. См. Роли пользователей для получения дополнительной информации.

Параметры

(массив) ID удаляемых пользователей.

Возвращаемые значения

(объект) Возвращает объект, который содержит ID удаленных пользователей, указанных в свойстве userids.

Примеры

Удаление нескольких пользователей

Удаление двух пользователей.

Запрос:

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

Ответ:

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

Источник

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