user.checkAuthentication

Описание

object user.checkAuthentication

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

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

Параметры

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

Parameter Type Description
extend boolean Следует ли продлевать сеанс пользователя.

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

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

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

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

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

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

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

Property Type Description
auth_type integer Метод аутентификации по умолчанию для пользователя.

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

См. свойство debug_mode объекта User group object для списка возможных значений.
deprovisioned boolean Принадлежит ли пользователь группе deprovisioned users group.
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.