user.checkAuthentication

Описание

object user.checkAuthentication

Этот метод проверяет и продлевает пользовательскую сессию.

Вызов метода user.checkAuthentication с использованием параметра sessionid по умолчанию продлевает пользовательскую сессию.

Параметры

Метод принимает следующие параметры.

Параметр Тип Описание
extend boolean Следует ли продлевать пользовательскую сессию.

Значение по умолчанию: "true".
Установка значения "false" позволяет проверить пользовательскую сессию без её продления.

Поведение параметра:
- поддерживается, если задан sessionid
sessionid string Пользовательский токен аутентификации.

Поведение параметра:
- обязателен, если token не задан
token string Пользовательский API-токен.

Поведение параметра:
- обязателен, если sessionid не задан

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

(object) Возвращает объект, содержащий информацию о пользователе.

В дополнение к стандартным свойствам пользователя возвращается следующая информация.

Свойство Type Описание
auth_type integer Аутентификация по умолчанию для пользователя.

Список возможных значений см. в свойстве authentication_type объекта Authentication object.
debug_mode integer Включён или отключён ли для пользователя режим отладки.

Список возможных значений см. в свойстве debug_mode объекта User group object.
deprovisioned boolean Принадлежит ли пользователь к группе деактивированных пользователей.
gui_access string Метод аутентификации пользователя в веб-интерфейс.

Список возможных значений см. в свойстве gui_access объекта User group object.
secret string Случайная строка из 32 символов. Генерируется при входе пользователя в систему.

Свойство secret не возвращается, если пользовательская сессия проверяется с использованием API-токена.
sessionid string Токен аутентификации, который должен использоваться в последующих API-запросах.

Свойство sessionid не возвращается, если пользовательская сессия проверяется с использованием API-токена.
type integer Тип пользователя.

Список возможных значений см. в свойстве type объекта Role object.
userip string IP-адрес пользователя.

Примеры

Проверка аутентификации с использованием токена аутентификации

Проверьте и продлите пользовательский сеанс с использованием токена аутентификации пользователя, а также верните дополнительную информацию о пользователе.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "user.checkAuthentication",
    "params": {
        "sessionid": "673b8ba11562a35da902c66cf5c23fa2"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "userid": "1",
        "username": "Admin",
        "name": "Zabbix",
        "surname": "Administrator",
        "url": "",
        "autologin": "1",
        "autologout": "0",
        "lang": "ru_RU",
        "refresh": "0",
        "theme": "default",
        "attempt_failed": "0",
        "attempt_ip": "127.0.0.1",
        "attempt_clock": "1355919038",
        "rows_per_page": "50",
        "timezone": "Europe/Riga",
        "roleid": "3",
        "userdirectoryid": "0",
        "ts_provisioned": "0",
        "type": 3,
        "userip": "127.0.0.1",
        "debug_mode": 0,
        "gui_access": "0",
        "deprovisioned": false,
        "auth_type": 0,
        "sessionid": "673b8ba11562a35da902c66cf5c23fa2",
        "secret": "0e329b933e46984e49a5c1051ecd0751"
    },
    "id": 1
}
Проверка аутентификации с использованием API-токена

Проверьте пользовательскую сессию с помощью API-токена пользователя и верните дополнительную информацию о пользователе.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "user.checkAuthentication",
    "params": {
        "token": "00aff470e07c12d707e50d98cfe39edef9e6ec349c14728dbdfbc8ddc5ea3eae"
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "userid": "1",
        "username": "Admin",
        "name": "Zabbix",
        "surname": "Administrator",
        "url": "",
        "autologin": "1",
        "autologout": "0",
        "lang": "ru_RU",
        "refresh": "0",
        "theme": "default",
        "attempt_failed": "0",
        "attempt_ip": "127.0.0.1",
        "attempt_clock": "1355919338",
        "rows_per_page": "50",
        "timezone": "Europe/Riga",
        "roleid": "3",
        "userdirectoryid": "0",
        "ts_provisioned": "0",
        "debug_mode": 0,
        "deprovisioned": false,
        "gui_access": "1",
        "mfaid": 0,
        "auth_type": 0,
        "type": 3,
        "userip": "127.0.0.1"
    },
    "id": 1
}

Источник

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