Benutzerobjekt

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

Benutzer

Das Benutzerobjekt verfügt über die folgenden Eigenschaften.

Property Type Description
userid ID ID des Benutzers.

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

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

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

Verhalten der Eigenschaft:
- 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 Zuordnungen von Benutzergruppen übereinstimmen.
attempt_clock timestamp Zeitpunkt des letzten fehlgeschlagenen Anmeldeversuchs.

Verhalten der Eigenschaft:
- schreibgeschützt
attempt_failed integer Anzahl der kürzlich fehlgeschlagenen Anmeldeversuche.

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

Verhalten der Eigenschaft:
- 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 Sprache des Benutzers, 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.

Diese Eigenschaft wird seit Zabbix 7.0.9 unterstützt.

Verhalten der Eigenschaft:
- 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, 2h, 1d).

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

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

Mögliche Werte:
default - (Standard) Systemstandard;
blue-theme - Blau;
dark-theme - Dunkel;
hc-light - Heller hoher Kontrast;
hc-dark - Dunkler hoher Kontrast.
ts_provisioned timestamp Zeitpunkt, zu dem der letzte Bereitstellungsvorgang durchgeführt wurde.

Verhalten der Eigenschaft:
- schreibgeschützt
- unterstützt für Benutzer vom Typ Super admin (seit Zabbix 7.0.9)
url string URL der Seite, auf die der Benutzer nach der Anmeldung weitergeleitet werden soll.
userdirectoryid ID ID des Benutzerverzeichnisses, mit dem der Benutzer verknüpft ist.

Wird für die Bereitstellung (Erstellung oder Aktualisierung) 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.

Verhalten der Eigenschaft:
- schreibgeschützt
- unterstützt für Benutzer vom Typ Super admin (seit Zabbix 7.0.9)
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.

Media

Das Media-Objekt hat die folgenden Eigenschaften.

Property Type Description
mediaid ID ID des Media des Benutzers.

Property behavior:
- read-only
mediatypeid ID ID des Medientyps, der vom Media des Benutzers verwendet wird.

Property behavior:
- required
sendto string/array Adresse, Benutzername oder andere Kennung des Empfängers.

Wenn type des Media type auf "Email" gesetzt ist, werden Werte als Array dargestellt. Für andere Typen von Media types wird der Wert als Zeichenfolge dargestellt.

Property behavior:
- required
active integer Ob das Media aktiviert ist.

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

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

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

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

Standard: 1-7,00:00-24:00.
provisioned integer Ob der Benutzer provisioned wurde.

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

Diese Eigenschaft wird seit Zabbix 7.0.9 unterstützt.
userdirectory_mediaid ID ID der Zuordnung von Benutzerverzeichnis-Media für provisioned Media.

Property behavior:
- read-only
- supported für Benutzer vom Typ Super admin (seit Zabbix 7.0.9)