user.logout

Описание

строка/объект user.logout(массив)

Этот метод позволяет выполнять выход из API и аннулировать текущий токен аутентификации.

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

Параметры

(массив) Метод принимает пустой массив.

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

(логическое) Возвращает true, если пользователь успешно выполнил выход.

Примеры

Выполнение выхода

Выполнить выход из API.

Запрос:

{
           "jsonrpc": "2.0",
           "method": "user.logout",
           "params": [],
           "id": 1,
           "auth": "16a46baf181ef9602e1687f3110abf8a"
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": true,
           "id": 1
       }

Смотрите также

user.login

Исходный код

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

Documentation