user.checkAuthentication

Beschreibung

object user.checkAuthentication

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

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

Parameter

Die Methode akzeptiert die folgenden Parameter.

Parameter Type Beschreibung
extend boolean Gibt an, ob die Benutzersitzung verlängert werden soll.

Standardwert: "true".
Wenn der Wert auf "false" gesetzt wird, kann die Benutzersitzung geprüft werden, ohne sie zu verlängern.

Parameterverhalten:
- unterstützt, wenn sessionid gesetzt ist
sessionid string Authentifizierungs-Token des Benutzers.

Parameterverhalten:
- erforderlich, wenn token nicht gesetzt ist
token string API-Token des Benutzers.

Parameterverhalten:
- erforderlich, wenn sessionid nicht gesetzt ist

Rückgabewerte

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

Zusätzlich zu den Standard-Benutzereigenschaften werden die folgenden Informationen zurückgegeben.

Eigenschaft Type Beschreibung
auth_type integer Standardauthentifizierung für den Benutzer.

Eine Liste der möglichen Werte finden Sie in der Eigenschaft authentication_type des Authentifizierungsobjekts.
debug_mode integer Gibt an, ob der Debug-Modus für den Benutzer aktiviert oder deaktiviert ist.

Eine Liste der möglichen Werte finden Sie in der Eigenschaft debug_mode des Benutzergruppenobjekts.
deprovisioned boolean Gibt an, ob der Benutzer zu einer Gruppe deprovisionierter Benutzer gehört.
gui_access string Authentifizierungsmethode des Benutzers für das Frontend.

Eine Liste der möglichen Werte finden Sie in der Eigenschaft gui_access des Benutzergruppenobjekts.
secret string Zufällige Zeichenfolge mit 32 Zeichen. Wird bei der Benutzeranmeldung generiert.

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.

Die Eigenschaft sessionid wird nicht zurückgegeben, wenn die Benutzersitzung mit einem API-Token geprüft wird.
type integer Benutzertyp.

Eine Liste der möglichen Werte finden Sie in der Eigenschaft type des Rollenobjekts.
userip string IP-Adresse des Benutzers.

Beispiele

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:

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

Antwort:

{
    "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
}
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:

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

Antwort:

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

Quelle

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