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

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

[comment]: # ({3c28b1f2-a9b9d697})
### Descrição

`object user.checkAuthentication`

Este método verifica e prolonga a sessão do usuário.

::: noteimportant
Chamar o método `user.checkAuthentication` usando o parâmetro `sessionid` prolonga a sessão do usuário por padrão.
:::

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

[comment]: # ({22aef924-49a0b391})
### Parâmetros

O método aceita os seguintes parâmetros.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|extend|boolean|Se a sessão do usuário deve ser prolongada.<br><br>Valor padrão: "true".<br>Definir o valor como "false" permite verificar a sessão do usuário sem prolongá-la.<br><br>[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):<br>- *suportado* se `sessionid` estiver definido|
|sessionid|string|[Token de autenticação](/manual/api#authentication) do usuário.<br><br>[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):<br>- *obrigatório* se `token` não estiver definido|
|token|string|[Token de API](/manual/api#authentication) do usuário.<br><br>[Comportamento do parâmetro](/manual/api/reference_commentary#parameter-behavior):<br>- *obrigatório* se `sessionid` não estiver definido|

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

[comment]: # ({b0d25373-a8544e3e})
### Valores de retorno

`(object)` Retorna um objeto contendo informações sobre o usuário.

Além das [propriedades padrão do usuário](object#user), as seguintes informações são retornadas.

|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|auth\_type|integer|Autenticação padrão para o usuário.<br><br>Consulte a propriedade `authentication_type` do [objeto Authentication](/manual/api/reference/authentication/object#authentication-object) para uma lista de valores possíveis.|
|debug\_mode|integer|Se o modo de depuração está habilitado ou desabilitado para o usuário.<br><br>Consulte a propriedade `debug_mode` do [objeto User group](/manual/api/reference/usergroup/object#user-group) para uma lista de valores possíveis.|
|deprovisioned|boolean|Se o usuário pertence a um [grupo de usuários desprovisionados](/manual/web_interface/frontend_sections/users/authentication#configuration).|
|gui\_access|string|Método de autenticação do usuário no frontend.<br><br>Consulte a propriedade `gui_access` do [objeto User group](/manual/api/reference/usergroup/object#user-group) para uma lista de valores possíveis.|
|secret|string|String aleatória de 32 caracteres. É gerada no login do usuário.<br><br>A propriedade `secret` não é retornada se a sessão do usuário for verificada usando um token de API.|
|sessionid|string|Token de autenticação, que deve ser usado nas próximas requisições da API.<br><br>A propriedade `sessionid` não é retornada se a sessão do usuário for verificada usando um token de API.|
|type|integer|Tipo de usuário.<br><br>Consulte a propriedade `type` do [objeto Role](/manual/api/reference/role/object#role) para uma lista de valores possíveis.|
|userip|string|Endereço IP do usuário.|

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

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

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

[comment]: # ({ed94544a-d574e685})
##### Verificar autenticação usando o token de autenticação

Verifique e prolongue uma sessão de usuário usando o token de autenticação do usuário e retorne informações adicionais sobre o usuário.

[Requisição](/manual/api#performing-requests):

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

Resposta:

```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})
##### Verificar autenticação usando o token da API

Verifique uma sessão de usuário usando o token da API do usuário e retorne informações adicionais sobre o usuário.

[Requisição](/manual/api#performing-requests):

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

Resposta:

```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})
### Origem

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

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