Benutzerverzeichnis-Objekt

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

Benutzerverzeichnis

Das Objekt des Benutzerverzeichnisses verfügt über die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
userdirectoryid ID ID des Benutzerverzeichnisses.

Wenn ein Benutzerverzeichnis gelöscht wird, wird der Wert der Eigenschaft userdirectoryid des Benutzerobjekts für alle Benutzer, die mit dem gelöschten Benutzerverzeichnis verknüpft sind, auf „0“ gesetzt.

Eigenschaftsverhalten:
- schreibgeschützt
- erforderlich für Aktualisierungsvorgänge
idp_type integer Typ des vom Identitätsanbieter für das Benutzerverzeichnis verwendeten Authentifizierungsprotokolls.
Beachten Sie, dass nur ein Benutzerverzeichnis vom Typ SAML vorhanden sein kann.

Mögliche Werte:
1 - Benutzerverzeichnis vom Typ LDAP;
2 - Benutzerverzeichnis vom Typ SAML.

Eigenschaftsverhalten:
- erforderlich für Erstellungsvorgänge
group_name string Attribut des LDAP-/SAML-Benutzerverzeichnisses, das den Gruppennamen enthält, der zur Zuordnung von Gruppen zwischen dem LDAP-/SAML-Benutzerverzeichnis und Zabbix verwendet wird.

Beispiel: cn

Eigenschaftsverhalten:
- erforderlich, wenn provision_status auf „Enabled“ gesetzt ist und saml_jit_status des Authentifizierungsobjekts auf „Enabled for configured SAML IdPs“ gesetzt ist
user_username string Attribut des LDAP-/SAML-Benutzerverzeichnisses (auch SCIM-Attribut, wenn scim_status auf „SCIM provisioning is enabled“ gesetzt ist), das den Namen des Benutzers enthält und bei der Bereitstellung des Benutzers als Wert für die Eigenschaft name des Benutzerobjekts verwendet wird.

Beispiele: cn, commonName, displayName, name
user_lastname string Attribut des LDAP-/SAML-Benutzerverzeichnisses (auch SCIM-Attribut, wenn scim_status auf „SCIM provisioning is enabled“ gesetzt ist), das den Nachnamen des Benutzers enthält und bei der Bereitstellung des Benutzers als Wert für die Eigenschaft surname des Benutzerobjekts verwendet wird.

Beispiele: sn, surname, lastName
provision_status integer Bereitstellungsstatus des Benutzerverzeichnisses.

Mögliche Werte:
0 - (Standard) Deaktiviert (die Bereitstellung von Benutzern, die von diesem Benutzerverzeichnis erstellt wurden, ist deaktiviert);
1 - Aktiviert (die Bereitstellung von Benutzern, die von diesem Benutzerverzeichnis erstellt wurden, ist aktiviert; zusätzlich muss der Status der LDAP- oder SAML-Bereitstellung (ldap_jit_status oder saml_jit_status des Authentifizierungsobjekts) aktiviert sein).
provision_groups array Array von Objekten für Zuordnungen von Bereitstellungsgruppen zur Zuordnung von LDAP-/SAML-Benutzergruppenmustern zu Zabbix-Benutzergruppe und Benutzerrolle.

Eigenschaftsverhalten:
- erforderlich, wenn provision_status auf „Enabled“ gesetzt ist
provision_media array Array von Objekten für Zuordnungen von Medientypen zur Zuordnung der LDAP-/SAML-Medienattribute des Benutzers (z. B. E-Mail) zu Zabbix-Benutzermedien für den Versand von Benachrichtigungen.
LDAP-spezifische Eigenschaften:
name string Eindeutiger Name des Benutzerverzeichnisses.

Eigenschaftsverhalten:
- erforderlich, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
host string Hostname, IP-Adresse oder URI des LDAP-Servers.
Die URI muss Schema (ldap:// oder ldaps://), Host und optional den Port enthalten.

Beispiele:
host.example.com
127.0.0.1
ldap://ldap.example.com:389

Eigenschaftsverhalten:
- erforderlich, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
port integer Port des LDAP-Servers.

Eigenschaftsverhalten:
- erforderlich, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
base_dn string Basispfad des LDAP-Benutzerverzeichnisses zu den Benutzerkonten.

Beispiele:
ou=Users,dc=example,dc=org
ou=Users,ou=system (für OpenLDAP)
DC=company,DC=com (für Microsoft Active Directory)
uid=%{user},dc=example,dc=com (für direkte Benutzerbindung; der Platzhalter „%{user}“ ist obligatorisch)

Eigenschaftsverhalten:
- erforderlich, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
search_attribute string Attribut des LDAP-Benutzerverzeichnisses, anhand dessen das Benutzerkonto aus den im Anmeldeantrag bereitgestellten Informationen identifiziert wird.

Beispiele:
uid (für OpenLDAP)
sAMAccountName (für Microsoft Active Directory)

Eigenschaftsverhalten:
- erforderlich, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
bind_dn string Konto des LDAP-Servers für die Bindung und Suche auf dem LDAP-Server.

Bei direkter Benutzerbindung und anonymer Bindung muss bind_dn leer sein.

Beispiele:
uid=ldap_search,ou=system (für OpenLDAP)
CN=ldap_search,OU=user_group,DC=company,DC=com (für Microsoft Active Directory)
CN=Admin,OU=Users,OU=Zabbix,DC=zbx,DC=local

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
bind_password string LDAP-Passwort des Kontos für die Bindung und Suche auf dem LDAP-Server.

Bei direkter Benutzerbindung und anonymer Bindung muss bind_password leer sein.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
description string Beschreibung des Benutzerverzeichnisses.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
group_basedn string Basispfad des LDAP-Benutzerverzeichnisses zu den Gruppen; wird zur Konfiguration einer Prüfung der Benutzerzugehörigkeit im LDAP-Benutzerverzeichnis verwendet.

Bei der Bereitstellung eines Benutzers ignoriert, wenn group_membership gesetzt ist.

Beispiel: ou=Groups,dc=example,dc=com

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
group_filter string Filterzeichenfolge zum Abrufen der LDAP-Benutzerverzeichnisgruppen, denen der Benutzer angehört; wird zur Konfiguration einer Prüfung der Benutzerzugehörigkeit im LDAP-Benutzerverzeichnis verwendet.

Bei der Bereitstellung eines Benutzers ignoriert, wenn group_membership gesetzt ist.

Unterstützte Platzhalter für group_filter:
%{attr} - Suchattribut (ersetzt durch den Eigenschaftswert von search_attribute);
%{groupattr} - Gruppenattribut (ersetzt durch den Eigenschaftswert von group_member);
%{host} - Hostname, IP-Adresse oder URI des LDAP-Servers (ersetzt durch den Eigenschaftswert von host);
%{user} - Benutzername des Zabbix-Benutzers.

Standard: (%{groupattr}=%{user})

Beispiele:
- (member=uid=%{ref},ou=Users,dc=example,dc=com) stimmt mit „User1“ überein, wenn ein LDAP-Gruppenobjekt das Attribut „member“ mit dem Wert „uid=User1,ou=Users,dc=example,dc=com“ enthält, und gibt die Gruppe zurück, der „User1“ angehört;
- (%{groupattr}=cn=%{ref},ou=Users,ou=Zabbix,DC=example,DC=com) stimmt mit „User1“ überein, wenn ein LDAP-Gruppenobjekt das in der Eigenschaft group_member angegebene Attribut mit dem Wert „cn=User1,ou=Users,ou=Zabbix,DC=example,DC=com“ enthält, und gibt die Gruppe zurück, der „User1“ angehört.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
group_member string Attribut des LDAP-Benutzerverzeichnisses, das Informationen über die Gruppenmitglieder enthält; wird zur Konfiguration einer Prüfung der Benutzerzugehörigkeit im LDAP-Benutzerverzeichnis verwendet.

Bei der Bereitstellung eines Benutzers ignoriert, wenn group_membership gesetzt ist.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
group_membership string Attribut des LDAP-Benutzerverzeichnisses, das Informationen über die Gruppen enthält, denen ein Benutzer angehört.

Beispiel: memberOf

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
search_filter string Benutzerdefinierte Filterzeichenfolge zum Auffinden und Authentifizieren eines Benutzers in einem LDAP-Benutzerverzeichnis anhand der im Anmeldeantrag bereitgestellten Informationen.

Unterstützte Platzhalter für search_filter:
%{attr} - Name des Suchattributs (z. B. uid, sAMAccountName);
%{user} - Benutzername des Zabbix-Benutzers.

Standard: (%{attr}=%{user})

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
start_tls integer Konfigurationsoption des LDAP-Servers, die es ermöglicht, die Kommunikation mit dem LDAP-Server mithilfe von Transport Layer Security (TLS) zu sichern.

Beachten Sie, dass start_tls für Hosts, die das Protokoll ldaps:// verwenden, auf „Disabled“ gesetzt sein muss.

Mögliche Werte:
0 - (Standard) Deaktiviert;
1 - Aktiviert.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
user_ref_attr string Attribut des LDAP-Benutzerverzeichnisses, das zur Referenzierung eines Benutzerobjekts verwendet wird. Der Wert von user_ref_attr wird verwendet, um Werte aus dem angegebenen Attribut im Benutzerverzeichnis abzurufen und sie anstelle des Platzhalters %{ref} in der Zeichenfolge group_filter einzusetzen.

Beispiele: cn, uid, member, uniqueMember

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type LDAP“ gesetzt ist
SAML-spezifische Eigenschaften:
idp_entityid string URI, die den Identitätsanbieter identifiziert und zur Kommunikation mit dem Identitätsanbieter in SAML-Nachrichten verwendet wird.

Beispiel: https://idp.example.com/idp

Eigenschaftsverhalten:
- erforderlich, wenn idp_type auf „User directory of type SAML“ gesetzt ist
sp_entityid string URL oder beliebige Zeichenfolge, die den Service Provider des Identitätsanbieters identifiziert.

Beispiele:
https://idp.example.com/sp
zabbix

Eigenschaftsverhalten:
- erforderlich, wenn idp_type auf „User directory of type SAML“ gesetzt ist
username_attribute string Attribut des SAML-Benutzerverzeichnisses (auch SCIM-Attribut, wenn scim_status auf „SCIM provisioning is enabled“ gesetzt ist), das den Benutzernamen enthält, der bei der Authentifizierung mit dem Wert der Eigenschaft username des Benutzerobjekts verglichen wird.

Beispiele: uid, userprincipalname, samaccountname, username, userusername, urn:oid:0.9.2342.19200300.100.1.1, urn:oid:1.3.6.1.4.1.5923.1.1.1.13, urn:oid:0.9.2342.19200300.100.1.44

Eigenschaftsverhalten:
- erforderlich, wenn idp_type auf „User directory of type SAML“ gesetzt ist
sso_url string URL des SAML-Single-Sign-on-Dienstes des Identitätsanbieters, an den Zabbix die SAML-Authentifizierungsanfragen sendet.

Beispiel: http://idp.example.com/idp/sso/saml

Eigenschaftsverhalten:
- erforderlich, wenn idp_type auf „User directory of type SAML“ gesetzt ist
slo_url string URL des SAML-Single-Log-out-Dienstes des Identitätsanbieters, an den Zabbix die SAML-Abmeldeanfragen sendet.

Beispiel: https://idp.example.com/idp/slo/saml

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist
encrypt_nameid integer Gibt an, ob die SAML-Namens-ID verschlüsselt werden soll.

Mögliche Werte:
0 - (Standard) Namens-ID nicht verschlüsseln;
1 - Namens-ID verschlüsseln.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist
encrypt_assertions integer Gibt an, ob die SAML-Assertions verschlüsselt werden sollen.

Mögliche Werte:
0 - (Standard) Assertions nicht verschlüsseln;
1 - Assertions verschlüsseln.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist
nameid_format string Namens-ID-Format des Service Providers des SAML-Identitätsanbieters.

Beispiele:
urn:oasis:names:tc:SAML:2.0:nameid-format:persistent
urn:oasis:names:tc:SAML:2.0:nameid-format:transient
urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos
urn:oasis:names:tc:SAML:2.0:nameid-format:entity

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist
scim_status integer Gibt an, ob die SCIM-Bereitstellung für SAML aktiviert oder deaktiviert ist.

Mögliche Werte:
0 - (Standard) SCIM-Bereitstellung ist deaktiviert;
1 - SCIM-Bereitstellung ist aktiviert.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist
sign_assertions integer Gibt an, ob die SAML-Assertions mit einer SAML-Signatur signiert werden sollen.

Mögliche Werte:
0 - (Standard) Assertions nicht signieren;
1 - Assertions signieren.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist
sign_authn_requests integer Gibt an, ob die SAML-AuthN-Anfragen mit einer SAML-Signatur signiert werden sollen.

Mögliche Werte:
0 - (Standard) AuthN-Anfragen nicht signieren;
1 - AuthN-Anfragen signieren.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist
sign_messages integer Gibt an, ob die SAML-Nachrichten mit einer SAML-Signatur signiert werden sollen.

Mögliche Werte:
0 - (Standard) Nachrichten nicht signieren;
1 - Nachrichten signieren.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist
sign_logout_requests integer Gibt an, ob die SAML-Abmeldeanfragen mit einer SAML-Signatur signiert werden sollen.

Mögliche Werte:
0 - (Standard) Abmeldeanfragen nicht signieren;
1 - Abmeldeanfragen signieren.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist
sign_logout_responses integer Gibt an, ob die SAML-Abmeldeantworten mit einer SAML-Signatur signiert werden sollen.

Mögliche Werte:
0 - (Standard) Abmeldeantworten nicht signieren;
1 - Abmeldeantworten signieren.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist
idp_certificate string Inhalt des Service-Provider-(SP-)Zertifikats für die Einrichtung des SAML-Single-Sign-on-(SSO-)Dienstes.

Beispiele:
-----BEGIN CERTIFICATE-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7...
...more encoded data...
-----END CERTIFICATE-----

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist und $SSO['CERT_STORAGE'] in der Frontend-Konfigurationsdatei auf database gesetzt ist
- nur schreiben
sp_private_key string Inhalt des privaten Schlüssels des Service Providers (SP) für die Einrichtung des SAML-Single-Sign-on-(SSO-)Dienstes.
Er ermöglicht eine sichere Authentifizierung und einen sicheren Datenaustausch mit dem Identitätsanbieter (IdP).

Beispiele:
-----BEGIN CERTIFICATE-----
MIIEvQIBADANBgkqhkiG9w0BA...
...more encoded data...
-----END CERTIFICATE-----

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist und $SSO['CERT_STORAGE'] in der Frontend-Konfigurationsdatei auf database gesetzt ist
- nur schreiben
sp_certificate string Inhalt des Service-Provider-(SP-)Zertifikats für die Einrichtung des SAML-Single-Sign-on-(SSO-)Dienstes.

Beispiele:
-----BEGIN CERTIFICATE-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7...
...more encoded data...
-----END CERTIFICATE-----

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist und $SSO['CERT_STORAGE'] in der Frontend-Konfigurationsdatei auf database gesetzt ist
- nur schreiben
idp_certificate_hash string Der MD5-Hash des Werts von idp_certificate. Für ein leeres idp_certificate wird eine leere Zeichenfolge zurückgegeben.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist und $SSO['CERT_STORAGE'] in der Frontend-Konfigurationsdatei auf database gesetzt ist
- schreibgeschützt
sp_private_key_hash string Der MD5-Hash des Werts von sp_private_key. Für einen leeren sp_private_key wird eine leere Zeichenfolge zurückgegeben.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist und $SSO['CERT_STORAGE'] in der Frontend-Konfigurationsdatei auf database gesetzt ist
- schreibgeschützt
sp_certificate_hash string Der MD5-Hash des Werts von sp_certificate. Für ein leeres sp_certificate wird eine leere Zeichenfolge zurückgegeben.

Eigenschaftsverhalten:
- unterstützt, wenn idp_type auf „User directory of type SAML“ gesetzt ist und $SSO['CERT_STORAGE'] in der Frontend-Konfigurationsdatei auf database gesetzt ist
- schreibgeschützt

Zuordnungen von Medientypen

Das Objekt für Medientyp-Zuordnungen hat die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
userdirectory_mediaid ID ID der Medientyp-Zuordnung.

Verhalten der Eigenschaft:
- schreibgeschützt
name string Sichtbarer Name in der Liste der Medientyp-Zuordnungen.

Verhalten der Eigenschaft:
- erforderlich
mediatypeid ID ID des zu erstellenden Medientyps; wird als Wert für die Eigenschaft mediatypeid des Media-Objekts verwendet.

Verhalten der Eigenschaft:
- erforderlich
attribute string LDAP-/SAML-Benutzerverzeichnisattribut (auch SCIM-Attribut, wenn scim_status auf "SCIM provisioning is enabled" gesetzt ist), das das Medium des Benutzers enthält (z. B. [email protected]), das als Wert für die Eigenschaft sendto des Media-Objekts verwendet wird.

Falls es in den vom LDAP-/SAML-Identitätsanbieter empfangenen Daten vorhanden ist und der Wert nicht leer ist, löst dies die Erstellung eines Mediums für den bereitgestellten Benutzer aus.

Verhalten der Eigenschaft:
- erforderlich
active integer Wert der Benutzermedien-Eigenschaft active, wenn für den bereitgestellten Benutzer ein Medium erstellt wird.

Mögliche Werte:
0 - (Standard) aktiviert;
1 - deaktiviert.
severity integer Wert der Benutzermedien-Eigenschaft severity, wenn für den bereitgestellten Benutzer ein Medium erstellt wird.

Standard: 63.
period string Wert der Benutzermedien-Eigenschaft period, wenn für den bereitgestellten Benutzer ein Medium erstellt wird.

Standard: 1-7,00:00-24:00.

Zuordnungen von Provisioning-Gruppen

Die Zuordnungen von Provisioning-Gruppen haben die folgenden Eigenschaften.

Eigenschaft Typ Beschreibung
name string Vollständiger Name einer Gruppe (z. B. Zabbix administrators) im LDAP-/SAML-Benutzerverzeichnis (auch SCIM, wenn scim_status auf „SCIM-Provisionierung ist aktiviert“ gesetzt ist).
Unterstützt das Platzhalterzeichen „*“.
Eindeutig über alle Zuordnungen von Provisioning-Gruppen hinweg.

Verhalten der Eigenschaft:
- erforderlich
roleid ID ID der Benutzerrolle, die dem Benutzer zugewiesen werden soll.

Wenn mehrere Zuordnungen von Provisioning-Gruppen übereinstimmen, wird dem Benutzer die Rolle mit dem höchsten Benutzertyp (User, Admin oder Super admin) zugewiesen. Wenn es mehrere Rollen mit demselben Benutzertyp gibt, wird dem Benutzer die erste Rolle (alphabetisch sortiert) zugewiesen.

Verhalten der Eigenschaft:
- erforderlich
user_groups array Array von Zabbix-Benutzergruppen-ID-Objekten. Jedes Objekt hat die folgenden Eigenschaften:
usrgrpid - (ID) ID der Zabbix-Benutzergruppe, die dem Benutzer zugewiesen werden soll.

Wenn mehrere Zuordnungen von Provisioning-Gruppen übereinstimmen, werden dem Benutzer die Zabbix-Benutzergruppen aller übereinstimmenden Zuordnungen zugewiesen.

Verhalten der Eigenschaft:
- erforderlich