[comment]: # translation:outdated

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

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

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

`object user.checkAuthentication`

Diese Methode prüft und verlängert die Benutzersitzung.

::: noteimportant
Der Aufruf der Methode `user.checkAuthentication` mit dem Parameter `sessionid` verlängert standardmäßig die Benutzersitzung.
:::

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

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

Die Methode akzeptiert die folgenden Parameter.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Beschreibung|
|--|--|------|
|extend|boolean|Gibt an, ob die Benutzersitzung verlängert werden soll.<br><br>Standardwert: "true".<br>Wenn der Wert auf "false" gesetzt wird, kann die Benutzersitzung geprüft werden, ohne sie zu verlängern.<br><br>[Parameterverhalten](/manual/api/reference_commentary#parameter-behavior):<br>- *unterstützt*, wenn `sessionid` gesetzt ist|
|sessionid|string|[Authentifizierungs-Token](/manual/api#authentication) des Benutzers.<br><br>[Parameterverhalten](/manual/api/reference_commentary#parameter-behavior):<br>- *erforderlich*, wenn `token` nicht gesetzt ist|
|token|string|[API-Token](/manual/api#authentication) des Benutzers.<br><br>[Parameterverhalten](/manual/api/reference_commentary#parameter-behavior):<br>- *erforderlich*, wenn `sessionid` nicht gesetzt ist|

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

[comment]: # ({b0d25373-a8544e3e})
### Rückgabewerte

`(object)` Gibt ein Objekt zurück, das Informationen über den Benutzer enthält.

Zusätzlich zu den [Standard-Benutzereigenschaften](object#user) werden die folgenden Informationen zurückgegeben.

|Eigenschaft|[Type](/manual/api/reference_commentary#data-types)|Beschreibung|
|--|--|------|
|auth\_type|integer|Standardauthentifizierung für den Benutzer.<br><br>Eine Liste der möglichen Werte finden Sie in der Eigenschaft `authentication_type` des [Authentifizierungsobjekts](/manual/api/reference/authentication/object#authentication-object).|
|debug\_mode|integer|Gibt an, ob der Debug-Modus für den Benutzer aktiviert oder deaktiviert ist.<br><br>Eine Liste der möglichen Werte finden Sie in der Eigenschaft `debug_mode` des [Benutzergruppenobjekts](/manual/api/reference/usergroup/object#user-group).|
|deprovisioned|boolean|Gibt an, ob der Benutzer zu einer [Gruppe deprovisionierter Benutzer](/manual/web_interface/frontend_sections/users/authentication#configuration) gehört.|
|gui\_access|string|Authentifizierungsmethode des Benutzers für das Frontend.<br><br>Eine Liste der möglichen Werte finden Sie in der Eigenschaft `gui_access` des [Benutzergruppenobjekts](/manual/api/reference/usergroup/object#user-group).|
|secret|string|Zufällige Zeichenfolge mit 32 Zeichen. Wird bei der Benutzeranmeldung generiert.<br><br>Die Eigenschaft `secret` wird nicht zurückgegeben, wenn die Benutzersitzung mit einem API-Token geprüft wird.|
|sessionid|string|Authentifizierungstoken, das in den folgenden API-Anfragen verwendet werden muss.<br><br>Die Eigenschaft `sessionid` wird nicht zurückgegeben, wenn die Benutzersitzung mit einem API-Token geprüft wird.|
|type|integer|Benutzertyp.<br><br>Eine Liste der möglichen Werte finden Sie in der Eigenschaft `type` des [Rollenobjekts](/manual/api/reference/role/object#role).|
|userip|string|IP-Adresse des Benutzers.|

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

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

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

[comment]: # ({ed94544a-d574e685})
##### Authentifizierung mit Authentifizierungs-Token prüfen

Prüfen und verlängern Sie eine Benutzersitzung mithilfe des Benutzerauthentifizierungs-Tokens und geben Sie zusätzliche Informationen über den Benutzer zurück.

[Anfrage](/manual/api#performing-requests):

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

Antwort:

```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})
##### Authentifizierung mit API-Token prüfen

Prüfen Sie eine Benutzersitzung mithilfe des Benutzer-API-Tokens und geben Sie zusätzliche Informationen über den Benutzer zurück.

[Anfrage](/manual/api#performing-requests):

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

Antwort:

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

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

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