user.login

Beschreibung

string/object user.login(object parameters)

Mit dieser Methode können Sie sich bei der API anmelden und ein Authentifizierungs-Token erzeugen.

Bei Verwendung dieser Methode müssen Sie außerdem user.logout ausführen, um die Erzeugung einer großen Anzahl offener Sitzungseinträge zu verhindern.

Diese Methode ist nur für nicht authentifizierte Benutzer verfügbar, die keiner Benutzergruppe mit aktivierter Multi-Faktor-Authentifizierung angehören.

Parameter

(object) Parameter, die den Benutzernamen und das Passwort enthalten.

Die Methode akzeptiert die folgenden Parameter.

Parameter Type Beschreibung
password string Benutzerpasswort.

Parameter behavior:
- erforderlich
username string Benutzername.

Parameter behavior:
- erforderlich
userData flag Gibt Informationen über den authentifizierten Benutzer zurück.

Rückgabewerte

(string/object) Wenn der Parameter userData verwendet wird, wird ein Objekt zurückgegeben, das Informationen über den authentifizierten Benutzer enthält.

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

Eigenschaft Typ 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.
mfaid integer ID der MFA-Methode, die beim Anmelden für den Benutzer verwendet wird.

Gibt "0" zurück, wenn MFA global oder für alle Benutzergruppen, denen der Benutzer angehört, deaktiviert ist.
secret string Zufällige Zeichenfolge mit 32 Zeichen. Wird bei der Benutzeranmeldung generiert.
sessionid string Authentifizierungstoken, das in den folgenden API-Anfragen verwendet werden muss.
type integer Benutzertyp.

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

Wenn ein Benutzer nach einem oder mehreren fehlgeschlagenen Versuchen erfolgreich authentifiziert wurde, gibt die Methode die aktuellen Werte für die Eigenschaften attempt_clock, attempt_failed und attempt_ip zurück und setzt sie anschließend zurück.

Wenn der Parameter userData nicht verwendet wird, gibt die Methode ein Authentifizierungstoken zurück, das für die Authentifizierung erforderlich ist.

Beispiele

Einen Benutzer authentifizieren

Authentifizieren Sie einen Benutzer.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "user.login",
    "params": {
        "username": "Admin",
        "password": "zabbix"
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": "0424bd59b807674191e7d77572075f33",
    "id": 1
}

Informationen des authentifizierten Benutzers anfordern

Authentifizieren und zusätzliche Informationen über den Benutzer zurückgeben.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "user.login",
    "params": {
        "username": "Admin",
        "password": "zabbix",
        "userData": true
    },
    "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",
        "type": 3,
        "userip": "127.0.0.1",
        "debug_mode": 0,
        "gui_access": "0",
        "mfaid": "1",
        "deprovisioned": false,
        "auth_type": 0,
        "sessionid": "5b56eee8be445e98f0bd42b435736e42",
        "secret": "cd0ba923319741c6586f3d866423a8f4"
    },
    "id": 1
}

Siehe auch

Quelle

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