[comment]: # aside: 1 [comment]: # ({c9088bab-f9e8f670}) # Benutzerverzeichnis-Objekt Die folgenden Objekte stehen in direktem Zusammenhang mit der `userdirectory` API. [comment]: # ({/c9088bab-f9e8f670}) [comment]: # ({4529ab95-ad144502}) ### Benutzerverzeichnis Das Objekt Benutzerverzeichnis hat die folgenden Eigenschaften. |Eigenschaft|[Typ](/manual/api/reference_commentary#data-types)|Beschreibung| |--|--|------| |userdirectoryid|ID|ID des Benutzerverzeichnisses.

Wenn ein Benutzerverzeichnis gelöscht wird, wird der Wert der Eigenschaft `userdirectoryid` des [Benutzerobjekts](/manual/api/reference/user/object#user) für alle Benutzer, die mit dem gelöschten Benutzerverzeichnis verknüpft sind, auf "0" gesetzt.

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *erforderlich* für Erstellungsoperationen| |group_name|string|LDAP/SAML-Benutzerverzeichnisattribut, das den Gruppennamen enthält, der zum Zuordnen von Gruppen zwischen dem LDAP/SAML-Benutzerverzeichnis und Zabbix verwendet wird.

Beispiel: *cn*

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *erforderlich*, wenn `provision_status` auf "Enabled" gesetzt ist und `saml_jit_status` des [Authentifizierungsobjekts](/manual/api/reference/authentication/object#authentication) auf "Enabled for configured SAML IdPs" gesetzt ist| |user_username|string|LDAP/SAML-Benutzerverzeichnisattribut (auch SCIM-Attribut, wenn `scim_status` auf "SCIM provisioning is enabled" gesetzt ist), das den Benutzernamen enthält, der bei der Bereitstellung des Benutzers als Wert für die Eigenschaft `name` des [Benutzerobjekts](/manual/api/reference/user/object#user) verwendet wird.

Beispiele: *cn*, *commonName*, *displayName*, *name*| |user_lastname|string|LDAP/SAML-Benutzerverzeichnisattribut (auch SCIM-Attribut, wenn `scim_status` auf "SCIM provisioning is enabled" gesetzt ist), das den Nachnamen des Benutzers enthält, der bei der Bereitstellung des Benutzers als Wert für die Eigenschaft `surname` des [Benutzerobjekts](/manual/api/reference/user/object#user) 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](/manual/api/reference/authentication/object#authentication)) aktiviert sein).| |provision_groups|array|Array von Objekten vom Typ [Bereitstellungsgruppen-Zuordnungen](object#provisioning-groups-mappings) zum Zuordnen eines LDAP/SAML-Benutzergruppenmusters zu einer Zabbix-Benutzergruppe und einer Benutzerrolle.

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *erforderlich*, wenn `provision_status` auf "Enabled" gesetzt ist| |provision_media|array|Array von Objekten vom Typ [Medientyp-Zuordnungen](object#media-type-mappings) zum Zuordnen der LDAP/SAML-Medienattribute eines Benutzers (z. B. E-Mail) zu Zabbix-Benutzermedien für den Versand von Benachrichtigungen.| |**[LDAP](/manual/web_interface/frontend_sections/users/authentication/ldap)-spezifische Eigenschaften:**|<|<| |name|string|Eindeutiger Name des Benutzerverzeichnisses.

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *erforderlich*, wenn `idp_type` auf "User directory of type LDAP" gesetzt ist| |host|string|Hostname, IP oder URI des LDAP-Servers.
Die URI muss Schema (`ldap://` oder `ldaps://`), Host und Port (optional) enthalten.

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

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *erforderlich*, wenn `idp_type` auf "User directory of type LDAP" gesetzt ist| |port|integer|Port des LDAP-Servers.

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *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; Platzhalter "*%{user}*" ist zwingend erforderlich)

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *erforderlich*, wenn `idp_type` auf "User directory of type LDAP" gesetzt ist| |search_attribute|string|LDAP-Benutzerverzeichnisattribut, anhand dessen das Benutzerkonto aus den in der Anmeldeanforderung bereitgestellten Informationen identifiziert wird.

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

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *erforderlich*, wenn `idp_type` auf "User directory of type LDAP" gesetzt ist| |bind_dn|string|LDAP-Serverkonto für die Bindung und die Suche auf dem LDAP-Server.

Für direkte Benutzerbindung und anonyme 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](/manual/api/reference_commentary#property-behavior):
- *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 die Suche auf dem LDAP-Server.

Für direkte Benutzerbindung und anonyme Bindung muss `bind_password` leer sein.

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type LDAP" gesetzt ist| |description|string|Beschreibung des Benutzerverzeichnisses.

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type LDAP" gesetzt ist| |group_basedn|string|Basispfad des LDAP-Benutzerverzeichnisses zu den Gruppen; wird verwendet, um eine Mitgliedschaftsprüfung für Benutzer im LDAP-Benutzerverzeichnis zu konfigurieren.

Wird bei der Bereitstellung eines Benutzers ignoriert, wenn `group_membership` gesetzt ist.

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

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *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 verwendet, um eine Mitgliedschaftsprüfung für Benutzer im LDAP-Benutzerverzeichnis zu konfigurieren.

Wird bei der Bereitstellung eines Benutzers ignoriert, wenn `group_membership` gesetzt ist.

Unterstützte Platzhalter für `group_filter`:
*%{attr}* - Suchattribut (ersetzt durch den Wert der Eigenschaft `search_attribute`);
*%{groupattr}* - Gruppenattribut (ersetzt durch den Wert der Eigenschaft `group_member`);
*%{host}* - Hostname, IP oder URI des LDAP-Servers (ersetzt durch den Wert der Eigenschaft `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](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type LDAP" gesetzt ist| |group_member|string|LDAP-Benutzerverzeichnisattribut, das Informationen über die Gruppenmitglieder enthält; wird verwendet, um eine Mitgliedschaftsprüfung für Benutzer im LDAP-Benutzerverzeichnis zu konfigurieren.

Wird bei der Bereitstellung eines Benutzers ignoriert, wenn `group_membership` gesetzt ist.

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type LDAP" gesetzt ist| |group_membership|string|LDAP-Benutzerverzeichnisattribut, das Informationen über die Gruppen enthält, denen ein Benutzer angehört.

Beispiel: *memberOf*

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type LDAP" gesetzt ist| |search_filter|string|Benutzerdefinierte Filterzeichenfolge, die verwendet wird, um einen Benutzer in einem LDAP-Benutzerverzeichnis anhand der in der Anmeldeanforderung bereitgestellten Informationen zu lokalisieren und zu authentifizieren.

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

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

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *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) abzusichern.

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](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type LDAP" gesetzt ist| |user_ref_attr|string|LDAP-Benutzerverzeichnisattribut, 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](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type LDAP" gesetzt ist| |**[SAML](/manual/web_interface/frontend_sections/users/authentication/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](/manual/api/reference_commentary#property-behavior):
- *erforderlich*, wenn `idp_type` auf "User directory of type SAML" gesetzt ist| |sp_entityid|string|URL oder beliebige Zeichenfolge, die den Dienstanbieter des Identitätsanbieters identifiziert.

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

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *erforderlich*, wenn `idp_type` auf "User directory of type SAML" gesetzt ist| |username_attribute|string|SAML-Benutzerverzeichnisattribut (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](/manual/api/reference/user/object#user) 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](/manual/api/reference_commentary#property-behavior):
- *erforderlich*, wenn `idp_type` auf "User directory of type SAML" gesetzt ist| |sso_url|string|URL des SAML-SSO-Dienstes des Identitätsanbieters, an den Zabbix die SAML-Authentifizierungsanforderungen sendet.

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

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *erforderlich*, wenn `idp_type` auf "User directory of type SAML" gesetzt ist| |slo_url|string|URL des SAML-Single-Logout-Dienstes des Identitätsanbieters, an den Zabbix die SAML-Abmeldeanforderungen sendet.

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

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type SAML" gesetzt ist| |encrypt_nameid|integer|Ob die SAML-Name-ID verschlüsselt werden soll.

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

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type SAML" gesetzt ist| |encrypt_assertions|integer|Ob die SAML-Assertions verschlüsselt werden sollen.

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

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type SAML" gesetzt ist| |nameid_format|string|Name-ID-Format des Dienstanbieters 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](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type SAML" gesetzt ist| |scim_status|integer|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](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type SAML" gesetzt ist| |sign_assertions|integer|Ob die SAML-Assertions mit einer SAML-Signatur signiert werden sollen.

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

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type SAML" gesetzt ist| |sign_authn_requests|integer|Ob die SAML-AuthN-Anforderungen mit einer SAML-Signatur signiert werden sollen.

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

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type SAML" gesetzt ist| |sign_messages|integer|Ob die SAML-Nachrichten mit einer SAML-Signatur signiert werden sollen.

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

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type SAML" gesetzt ist| |sign_logout_requests|integer|Ob die SAML-Abmeldeanforderungen mit einer SAML-Signatur signiert werden sollen.

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

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type SAML" gesetzt ist| |sign_logout_responses|integer|Ob die SAML-Abmeldereaktionen mit einer SAML-Signatur signiert werden sollen.

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

[Eigenschaftsverhalten](/manual/api/reference_commentary#property-behavior):
- *unterstützt*, wenn `idp_type` auf "User directory of type SAML" gesetzt ist| [comment]: # ({/4529ab95-ad144502}) [comment]: # ({07d3d820-c2b51996}) #### Zuordnungen von Medientypen Das Objekt für Medientyp-Zuordnungen hat die folgenden Eigenschaften. |Eigenschaft|[Typ](/manual/api/reference_commentary#data-types)|Beschreibung| |--|--|----------------| |userdirectory_mediaid|ID|ID der Medientyp-Zuordnung.

[Verhalten der Eigenschaft](/manual/api/reference_commentary#property-behavior):
- *schreibgeschützt*| |name|string|Sichtbarer Name in der Liste der Medientyp-Zuordnungen.

[Verhalten der Eigenschaft](/manual/api/reference_commentary#property-behavior):
- *erforderlich*| |mediatypeid|ID|ID des zu erstellenden Medientyps; wird als Wert für die Eigenschaft `mediatypeid` des [Media-Objekts](/manual/api/reference/user/object#media) verwendet.

[Verhalten der Eigenschaft](/manual/api/reference_commentary#property-behavior):
- *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. *user@example.com*), das als Wert für die Eigenschaft `sendto` des [Media-Objekts](/manual/api/reference/user/object#media) 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](/manual/api/reference_commentary#property-behavior):
- *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.| [comment]: # ({/07d3d820-c2b51996}) [comment]: # ({fe544518-67bd0ce1}) #### Zuordnungen von Provisioning-Gruppen Die Zuordnungen von Provisioning-Gruppen haben die folgenden Eigenschaften. |Eigenschaft|[Typ](/manual/api/reference_commentary#data-types)|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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *erforderlich*| [comment]: # ({/fe544518-67bd0ce1})