user.delete

Описание

object user.delete(массив users)

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

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

Параметры

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

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

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

Примеры

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

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

Запрос:

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

Ответ:

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

Источник

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

Documentation