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

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

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

`object user.checkAuthentication`

Cette méthode vérifie et prolonge la session utilisateur.

::: noteimportant
L'appel de la méthode `user.checkAuthentication` à l'aide du paramètre `sessionid` prolonge la session utilisateur par défaut.
:::

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

[comment]: # ({22aef924-49a0b391})
### Paramètres

La méthode accepte les paramètres suivants.

|Paramètre|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|extend|boolean|Indique s'il faut prolonger la session utilisateur.<br><br>Valeur par défaut : "true".<br>Définir la valeur sur "false" permet de vérifier la session utilisateur sans la prolonger.<br><br>[Comportement du paramètre](/manual/api/reference_commentary#parameter-behavior) :<br>- *pris en charge* si `sessionid` est défini|
|sessionid|string|[Jeton d'authentification](/manual/api#authentication) de l'utilisateur.<br><br>[Comportement du paramètre](/manual/api/reference_commentary#parameter-behavior) :<br>- *obligatoire* si `token` n'est pas défini|
|token|string|[Jeton d'API](/manual/api#authentication) de l'utilisateur.<br><br>[Comportement du paramètre](/manual/api/reference_commentary#parameter-behavior) :<br>- *obligatoire* si `sessionid` n'est pas défini|

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

[comment]: # ({b0d25373-a8544e3e})
### Valeurs de retour

`(object)` Renvoie un objet contenant des informations sur l'utilisateur.

En plus des [propriétés utilisateur standard](object#user), les informations suivantes sont renvoyées.

|Propriété|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|auth\_type|integer|Authentification par défaut pour l'utilisateur.<br><br>Consultez la propriété `authentication_type` de l'[objet Authentication](/manual/api/reference/authentication/object#authentication-object) pour obtenir la liste des valeurs possibles.|
|debug\_mode|integer|Indique si le mode de débogage est activé ou désactivé pour l'utilisateur.<br><br>Consultez la propriété `debug_mode` de l'[objet Groupe d'utilisateurs](/manual/api/reference/usergroup/object#user-group) pour obtenir la liste des valeurs possibles.|
|deprovisioned|boolean|Indique si l'utilisateur appartient à un [groupe d'utilisateurs déprovisionnés](/manual/web_interface/frontend_sections/users/authentication#configuration).|
|gui\_access|string|Méthode d'authentification de l'utilisateur pour l'interface.<br><br>Consultez la propriété `gui_access` de l'[objet Groupe d'utilisateurs](/manual/api/reference/usergroup/object#user-group) pour obtenir la liste des valeurs possibles.|
|secret|string|Chaîne aléatoire de 32 caractères. Elle est générée lors de la connexion de l'utilisateur.<br><br>La propriété `secret` n'est pas renvoyée si la session utilisateur est vérifiée à l'aide d'un jeton d'API.|
|sessionid|string|Jeton d'authentification, qui doit être utilisé dans les requêtes API suivantes.<br><br>La propriété `sessionid` n'est pas renvoyée si la session utilisateur est vérifiée à l'aide d'un jeton d'API.|
|type|integer|Type d'utilisateur.<br><br>Consultez la propriété `type` de l'[objet Role](/manual/api/reference/role/object#role) pour obtenir la liste des valeurs possibles.|
|userip|string|Adresse IP de l'utilisateur.|

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

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

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

[comment]: # ({ed94544a-d574e685})
##### Vérifier l'authentification à l'aide du jeton d'authentification

Vérifiez et prolongez une session utilisateur à l'aide du jeton d'authentification de l'utilisateur, puis renvoyez des informations supplémentaires sur l'utilisateur.

[Requête](/manual/api#performing-requests):

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

Réponse :

```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})
##### Vérifier l'authentification à l'aide d'un jeton API

Vérifiez une session utilisateur à l'aide du jeton API de l'utilisateur et renvoyez des informations supplémentaires sur l'utilisateur.

[Requête](/manual/api#performing-requests):

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

Réponse :

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

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

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