[comment]: # ({43f8bc43-43f8bc43})
# user.checkAuthentication

[comment]: # ({/43f8bc43-43f8bc43})

[comment]: # ({3c28b1f2-a9b9d697})
### Описание

`object user.checkAuthentication`

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

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

[comment]: # ({/3c28b1f2-a9b9d697})

[comment]: # ({22aef924-49a0b391})
### Параметры

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

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|extend|boolean|Следует ли продлевать сеанс пользователя.<br><br>Значение по умолчанию: "true".<br>Установка значения "false" позволяет проверить сеанс пользователя без его продления.<br><br>[Поведение параметра](/manual/api/reference_commentary#parameter-behavior):<br>- *supported* если `sessionid` задан|
|sessionid|string|[Токен аутентификации](/manual/api#authentication) пользователя.<br><br>[Поведение параметра](/manual/api/reference_commentary#parameter-behavior):<br>- *required* если `token` не задан|
|token|string|[API-токен](/manual/api#authentication) пользователя.<br><br>[Поведение параметра](/manual/api/reference_commentary#parameter-behavior):<br>- *required* если `sessionid` не задан|

[comment]: # ({/22aef924-49a0b391})

[comment]: # ({b0d25373-a8544e3e})
### Возвращаемые значения

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

В дополнение к [стандартным свойствам пользователя](object#user) возвращается следующая информация.

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|auth\_type|integer|Метод аутентификации по умолчанию для пользователя.<br><br>См. свойство `authentication_type` объекта [Authentication object](/manual/api/reference/authentication/object#authentication-object) для списка возможных значений.|
|debug\_mode|integer|Включен или отключен режим отладки для пользователя.<br><br>См. свойство `debug_mode` объекта [User group object](/manual/api/reference/usergroup/object#user-group) для списка возможных значений.|
|deprovisioned|boolean|Принадлежит ли пользователь группе [deprovisioned users group](/manual/web_interface/frontend_sections/users/authentication#configuration).|
|gui\_access|string|Метод аутентификации пользователя во веб-интерфейс.<br><br>См. свойство `gui_access` объекта [User group object](/manual/api/reference/usergroup/object#user-group) для списка возможных значений.|
|secret|string|Случайная строка из 32 символов. Генерируется при входе пользователя в систему.<br><br>Свойство `secret` не возвращается, если сеанс пользователя проверяется с использованием API-токена.|
|sessionid|string|Токен аутентификации, который необходимо использовать в следующих API-запросах.<br><br>Свойство `sessionid` не возвращается, если сеанс пользователя проверяется с использованием API-токена.|
|type|integer|Тип пользователя.<br><br>См. свойство `type` объекта [Role object](/manual/api/reference/role/object#role) для списка возможных значений.|
|userip|string|IP-адрес пользователя.|

[comment]: # ({/b0d25373-a8544e3e})

[comment]: # ({b41637d2-e79e2236})
### Примеры

[comment]: # ({/b41637d2-e79e2236})

[comment]: # ({ed94544a-d574e685})
##### Проверка аутентификации с использованием токена аутентификации

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

[Запрос](/manual/api#performing-requests):

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

Ответ:

```json
{
    "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
}
```

[comment]: # ({/ed94544a-d574e685})

[comment]: # ({45eaa4f3-698590d0})
##### Проверка аутентификации с использованием API-токена

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

[Запрос](/manual/api#performing-requests):

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

Ответ:

```json
{
    "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
}
```

[comment]: # ({/45eaa4f3-698590d0})

[comment]: # ({e7148ebe-97f5ed87})
### Источник

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

[comment]: # ({/e7148ebe-97f5ed87})