Auf dieser Seite

Benutzerobjekt

Die folgenden Objekte stehen in direktem Zusammenhang mit der user API.

Benutzer

Das Benutzerobjekt verfügt über die folgenden Eigenschaften.

Property Type Beschreibung
userid ID ID des Benutzers.

Eigenschaftsverhalten:
- schreibgeschützt
- erforderlich für Aktualisierungsvorgänge
username string Name des Benutzers.

Eigenschaftsverhalten:
- erforderlich für Erstellungsvorgänge
- schreibgeschützt für bereitgestellte Benutzer, wenn der Benutzer mit einem Benutzerverzeichnis verknüpft ist (userdirectoryid auf einen gültigen Wert ungleich „0“ gesetzt ist), der Bereitstellungsstatus des Benutzerverzeichnisses aktiviert ist (provision_status des Benutzerverzeichnisobjekts auf „1“ gesetzt ist) und der Authentifizierungsstatus für die LDAP- oder SAML-Bereitstellung aktiviert ist (ldap_jit_status des Authentifizierungsobjekts auf „Enabled for configured LDAP IdPs“ oder saml_jit_status des Authentifizierungsobjekts auf „Enabled for configured SAML IdPs“ gesetzt ist)
passwd string Passwort des Benutzers.

Der Wert dieses Parameters kann eine leere Zeichenfolge sein, wenn der Benutzer mit einem Benutzerverzeichnis verknüpft ist.

Eigenschaftsverhalten:
- nur schreibbar
roleid ID ID der Rolle des Benutzers.

Beachten Sie, dass sich Benutzer ohne Rolle nur über die LDAP-- oder SAML-Authentifizierung bei Zabbix anmelden können, sofern ihre LDAP-/SAML-Informationen mit den in Zabbix konfigurierten Benutzergruppen-Zuordnungen übereinstimmen.
attempt_clock timestamp Zeitpunkt des letzten fehlgeschlagenen Anmeldeversuchs.

Eigenschaftsverhalten:
- schreibgeschützt
attempt_failed integer Anzahl der letzten fehlgeschlagenen Anmeldeversuche.

Eigenschaftsverhalten:
- schreibgeschützt
attempt_ip string IP-Adresse, von der der letzte fehlgeschlagene Anmeldeversuch ausging.

Eigenschaftsverhalten:
- schreibgeschützt
autologin integer Gibt an, ob die automatische Anmeldung aktiviert werden soll.

Mögliche Werte:
0 - (Standard) automatische Anmeldung deaktiviert;
1 - automatische Anmeldung aktiviert.
autologout string Lebensdauer der Benutzersitzung. Akzeptiert eine Anzahl von Sekunden (z. B. 1, 60, 300) oder einen Wert mit einem Zeitsuffix (z. B. 30s, 1m, 2h). Bei Einstellung auf 0s läuft die Sitzung nie ab.

Standard: 15m.
lang string Sprachcode der Benutzersprache, z. B. en_US.

Standard: default - Systemstandard.
name string Vorname des Benutzers.
provisioned integer Gibt an, ob der Benutzer bereitgestellt wurde.

Mögliche Werte:
0 - nicht bereitgestellt;
1 - bereitgestellt.

Eigenschaftsverhalten:
- schreibgeschützt
refresh string Automatisches Aktualisierungsintervall. Akzeptiert eine Anzahl von Sekunden (z. B. 1, 60, 300) oder einen Wert mit einem Zeitsuffix (z. B. 30s, 1m, 1h).

Standard: 30s.
rows_per_page integer Anzahl der Objektzeilen, die pro Seite angezeigt werden.

Standard: 50.
surname string Nachname des Benutzers.
theme string Theme des Benutzers.

Mögliche Werte:
default - (Standard) Systemstandard;
blue-theme - Blau;
blue-classic-theme - Blau (klassisch);
dark-theme - Dunkel;
dark-blue-theme - Dunkelblau;
dark-classic-theme - Dunkel (klassisch);
hc-light - Helles Design mit hohem Kontrast;
hc-dark - Dunkles Design mit hohem Kontrast.
ts_provisioned timestamp Zeitpunkt, zu dem der letzte Bereitstellungsvorgang durchgeführt wurde.

Eigenschaftsverhalten:
- schreibgeschützt
- unterstützt für Benutzer vom Typ Super admin
url string URL der Seite, auf die der Benutzer nach der Anmeldung weitergeleitet wird.
userdirectoryid ID ID des Benutzerverzeichnisses, mit dem der Benutzer verknüpft ist.

Wird für die Bereitstellung (Erstellen oder Aktualisieren) sowie für die Anmeldung eines Benutzers verwendet, der mit einem Benutzerverzeichnis verknüpft ist.

Bei Anmeldevorgängen hat der Wert dieser Eigenschaft Vorrang vor der Eigenschaft userdirectoryid der Benutzergruppen, denen der Benutzer angehört.

Standard: 0.

Eigenschaftsverhalten:
- schreibgeschützt
- unterstützt für Benutzer vom Typ Super admin
timezone string Zeitzone des Benutzers, z. B. Europe/London, UTC.

Standard: default - Systemstandard.

Eine vollständige Liste der unterstützten Zeitzonen finden Sie in der PHP-Dokumentation.

Medien

Das Medienobjekt verfügt über die folgenden Eigenschaften.

Property Type Description
mediaid ID ID des Mediums des Benutzers.

Verhalten der Eigenschaft:
- schreibgeschützt
mediatypeid ID ID des Medientyps, der vom Medium des Benutzers verwendet wird.

Verhalten der Eigenschaft:
- erforderlich
sendto string/array Adresse, Benutzername oder sonstige Kennung des Empfängers.

Wenn type des Medientyps auf „Email“ oder „Push“ gesetzt ist, werden die Werte als Array dargestellt. Für „Push“ kann das Array entweder einen Platzhalter (*) oder eine oder mehrere IDs mobiler Geräte enthalten.

Wenn type des Medientyps auf „Script“, „SMS“ oder „Webhook“ gesetzt ist, wird der Wert als Zeichenfolge dargestellt.

Verhalten der Eigenschaft:
- erforderlich
active integer Gibt an, ob das Medium aktiviert ist.

Mögliche Werte:
0 - (Standard) aktiviert;
1 - deaktiviert.
severity integer Schweregrade von Auslösern, über die Benachrichtigungen gesendet werden sollen.

Mögliche Bitmap-Werte:
1 - Nicht klassifiziert;
2 - Information;
4 - Warnung;
8 - Durchschnittlich;
16 - Hoch;
32 - Katastrophe.

Dies ist ein Bitmaskenfeld; jede Summe möglicher Bitmap-Werte ist zulässig (zum Beispiel 48 für „Durchschnittlich“, „Hoch“ und „Katastrophe“).

Standard: 63.
period string Zeit, zu der die Benachrichtigungen als Zeitperiode oder durch Semikolons getrennte Benutzermakros gesendet werden können.

Standard: 1-7,00:00-24:00.
provisioned integer Gibt an, ob der Benutzer bereitgestellt wurde.

Mögliche Werte:
0 - nicht bereitgestellt;
1 - bereitgestellt.
userdirectory_mediaid ID ID der Medienzuordnung im Benutzerverzeichnis für bereitgestellte Medien.

Verhalten der Eigenschaft:
- schreibgeschützt
- unterstützt für Benutzer vom Typ Super admin