Obiekt katalogu użytkownika

Następujące obiekty są bezpośrednio powiązane z API userdirectory.

Katalog użytkowników

Obiekt katalogu użytkowników ma następujące właściwości.

Właściwość Typ Opis
userdirectoryid ID ID katalogu użytkowników.

Jeśli katalog użytkowników zostanie usunięty, wartość właściwości userdirectoryid obiektu User object zostanie ustawiona na "0" dla wszystkich użytkowników powiązanych z usuniętym katalogiem użytkowników.

Zachowanie właściwości:
- tylko do odczytu
- wymagane dla operacji aktualizacji
idp_type integer Typ protokołu uwierzytelniania używanego przez dostawcę tożsamości dla katalogu użytkowników.
Zwróć uwagę, że może istnieć tylko jeden katalog użytkowników typu SAML.

Możliwe wartości:
1 - Katalog użytkowników typu LDAP;
2 - Katalog użytkowników typu SAML.

Zachowanie właściwości:
- wymagane dla operacji tworzenia
group_name string Atrybut katalogu użytkowników LDAP/SAML zawierający nazwę grupy używaną do mapowania grup między katalogiem użytkowników LDAP/SAML a Zabbix.

Przykład: cn

Zachowanie właściwości:
- wymagane, jeśli provision_status jest ustawione na "Enabled", a saml_jit_status obiektu Authentication object jest ustawione na "Enabled for configured SAML IdPs"
user_username string Atrybut katalogu użytkowników LDAP/SAML (również atrybut SCIM, jeśli scim_status jest ustawione na "SCIM provisioning is enabled") zawierający imię użytkownika, które jest używane jako wartość właściwości name obiektu User object podczas provisioningu użytkownika.

Przykłady: cn, commonName, displayName, name
user_lastname string Atrybut katalogu użytkowników LDAP/SAML (również atrybut SCIM, jeśli scim_status jest ustawione na "SCIM provisioning is enabled") zawierający nazwisko użytkownika, które jest używane jako wartość właściwości surname obiektu User object podczas provisioningu użytkownika.

Przykłady: sn, surname, lastName
provision_status integer Status provisioningu katalogu użytkowników.

Możliwe wartości:
0 - (domyślnie) Wyłączone (provisioning użytkowników tworzonych przez ten katalog użytkowników jest wyłączony);
1 - Włączone (provisioning użytkowników tworzonych przez ten katalog użytkowników jest włączony; dodatkowo status provisioningu LDAP lub SAML (ldap_jit_status lub saml_jit_status obiektu Authentication object) musi być włączony).
provision_groups array Tablica obiektów mapowań grup provisioningu służących do mapowania wzorca grupy użytkowników LDAP/SAML na grupę użytkowników Zabbix i rolę użytkownika.

Zachowanie właściwości:
- wymagane, jeśli provision_status jest ustawione na "Enabled"
provision_media array Tablica obiektów mapowań typów mediów służących do mapowania atrybutów mediów LDAP/SAML użytkownika (np. adresu e-mail) na media użytkownika Zabbix do wysyłania powiadomień.
Właściwości specyficzne dla LDAP:
name string Unikalna nazwa katalogu użytkowników.

Zachowanie właściwości:
- wymagane, jeśli idp_type jest ustawione na "User directory of type LDAP"
host string Nazwa hosta, adres IP lub URI serwera LDAP.
URI musi zawierać schemat (ldap:// lub ldaps://), host i port (opcjonalnie).

Przykłady:
host.example.com
127.0.0.1
ldap://ldap.example.com:389

Zachowanie właściwości:
- wymagane, jeśli idp_type jest ustawione na "User directory of type LDAP"
port integer Port serwera LDAP.

Zachowanie właściwości:
- wymagane, jeśli idp_type jest ustawione na "User directory of type LDAP"
base_dn string Ścieżka bazowa katalogu użytkowników LDAP do kont użytkowników.

Przykłady:
ou=Users,dc=example,dc=org
ou=Users,ou=system (dla OpenLDAP)
DC=company,DC=com (dla Microsoft Active Directory)
uid=%{user},dc=example,dc=com (dla bezpośredniego wiązania użytkownika; symbol zastępczy "%{user}" jest obowiązkowy)

Zachowanie właściwości:
- wymagane, jeśli idp_type jest ustawione na "User directory of type LDAP"
search_attribute string Atrybut katalogu użytkowników LDAP, według którego identyfikowane jest konto użytkownika na podstawie informacji podanych w żądaniu logowania.

Przykłady:
uid (dla OpenLDAP)
sAMAccountName (dla Microsoft Active Directory)

Zachowanie właściwości:
- wymagane, jeśli idp_type jest ustawione na "User directory of type LDAP"
bind_dn string Konto serwera LDAP używane do wiązania i wyszukiwania w serwerze LDAP.

W przypadku bezpośredniego wiązania użytkownika i wiązania anonimowego bind_dn musi być puste.

Przykłady:
uid=ldap_search,ou=system (dla OpenLDAP)
CN=ldap_search,OU=user_group,DC=company,DC=com (dla Microsoft Active Directory)
CN=Admin,OU=Users,OU=Zabbix,DC=zbx,DC=local

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type LDAP"
bind_password string Hasło LDAP konta używanego do wiązania i wyszukiwania w serwerze LDAP.

W przypadku bezpośredniego wiązania użytkownika i wiązania anonimowego bind_password musi być puste.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type LDAP"
description string Opis katalogu użytkowników.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type LDAP"
group_basedn string Ścieżka bazowa katalogu użytkowników LDAP do grup; używana do skonfigurowania sprawdzania członkostwa użytkownika w katalogu użytkowników LDAP.

Ignorowane podczas provisioningu użytkownika, jeśli ustawiono group_membership.

Przykład: ou=Groups,dc=example,dc=com

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type LDAP"
group_filter string Ciąg filtra do pobierania grup katalogu użytkowników LDAP, których członkiem jest użytkownik; używany do skonfigurowania sprawdzania członkostwa użytkownika w katalogu użytkowników LDAP.

Ignorowane podczas provisioningu użytkownika, jeśli ustawiono group_membership.

Obsługiwane symbole zastępcze group_filter:
%{attr} - atrybut wyszukiwania (zastępowany wartością właściwości search_attribute);
%{groupattr} - atrybut grupy (zastępowany wartością właściwości group_member);
%{host} - nazwa hosta, adres IP lub URI serwera LDAP (zastępowane wartością właściwości host);
%{user} - nazwa użytkownika Zabbix.

Domyślnie: (%{groupattr}=%{user})

Przykłady:
- (member=uid=%{ref},ou=Users,dc=example,dc=com) dopasuje "User1", jeśli obiekt grupy LDAP zawiera atrybut "member" o wartości "uid=User1,ou=Users,dc=example,dc=com", i zwróci grupę, której członkiem jest "User1";
- (%{groupattr}=cn=%{ref},ou=Users,ou=Zabbix,DC=example,DC=com) dopasuje "User1", jeśli obiekt grupy LDAP zawiera atrybut określony we właściwości group_member o wartości "cn=User1,ou=Users,ou=Zabbix,DC=example,DC=com", i zwróci grupę, której członkiem jest "User1".

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type LDAP"
group_member string Atrybut katalogu użytkowników LDAP zawierający informacje o członkach grupy; używany do skonfigurowania sprawdzania członkostwa użytkownika w katalogu użytkowników LDAP.

Ignorowane podczas provisioningu użytkownika, jeśli ustawiono group_membership.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type LDAP"
group_membership string Atrybut katalogu użytkowników LDAP zawierający informacje o grupach, do których należy użytkownik.

Przykład: memberOf

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type LDAP"
search_filter string Niestandardowy ciąg filtra używany do lokalizowania i uwierzytelniania użytkownika w katalogu użytkowników LDAP na podstawie informacji podanych w żądaniu logowania.

Obsługiwane symbole zastępcze search_filter:
%{attr} - nazwa atrybutu wyszukiwania (np. uid, sAMAccountName);
%{user} - nazwa użytkownika Zabbix.

Domyślnie: (%{attr}=%{user})

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type LDAP"
start_tls integer Opcja konfiguracji serwera LDAP, która umożliwia zabezpieczenie komunikacji z serwerem LDAP przy użyciu Transport Layer Security (TLS).

Zwróć uwagę, że start_tls musi być ustawione na "Disabled" dla hostów używających protokołu ldaps://.

Możliwe wartości:
0 - (domyślnie) Wyłączone;
1 - Włączone.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type LDAP"
user_ref_attr string Atrybut katalogu użytkowników LDAP używany do odwoływania się do obiektu użytkownika. Wartość user_ref_attr jest używana do pobierania wartości z określonego atrybutu w katalogu użytkowników i umieszczania ich zamiast symbolu zastępczego %{ref} w ciągu group_filter.

Przykłady: cn, uid, member, uniqueMember

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type LDAP"
Właściwości specyficzne dla SAML:
idp_entityid string URI identyfikujący dostawcę tożsamości i używany do komunikacji z dostawcą tożsamości w komunikatach SAML.

Przykład: https://idp.example.com/idp

Zachowanie właściwości:
- wymagane, jeśli idp_type jest ustawione na "User directory of type SAML"
sp_entityid string URL lub dowolny ciąg identyfikujący dostawcę usług dostawcy tożsamości.

Przykłady:
https://idp.example.com/sp
zabbix

Zachowanie właściwości:
- wymagane, jeśli idp_type jest ustawione na "User directory of type SAML"
username_attribute string Atrybut katalogu użytkowników SAML (również atrybut SCIM, jeśli scim_status jest ustawione na "SCIM provisioning is enabled") zawierający nazwę użytkownika, która jest porównywana z wartością właściwości username obiektu User object podczas uwierzytelniania.

Przykłady: 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

Zachowanie właściwości:
- wymagane, jeśli idp_type jest ustawione na "User directory of type SAML"
sso_url string URL usługi jednokrotnego logowania SAML dostawcy tożsamości, do której Zabbix będzie wysyłać żądania uwierzytelniania SAML.

Przykład: http://idp.example.com/idp/sso/saml

Zachowanie właściwości:
- wymagane, jeśli idp_type jest ustawione na "User directory of type SAML"
slo_url string URL usługi jednokrotnego wylogowania SAML dostawcy tożsamości, do której Zabbix będzie wysyłać żądania wylogowania SAML.

Przykład: https://idp.example.com/idp/slo/saml

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML"
encrypt_nameid integer Określa, czy identyfikator nazwy SAML powinien być szyfrowany.

Możliwe wartości:
0 - (domyślnie) Nie szyfruj identyfikatora nazwy;
1 - Szyfruj identyfikator nazwy.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML"
encrypt_assertions integer Określa, czy asercje SAML powinny być szyfrowane.

Możliwe wartości:
0 - (domyślnie) Nie szyfruj asercji;
1 - Szyfruj asercje.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML"
nameid_format string Format identyfikatora nazwy dostawcy usług dostawcy tożsamości SAML.

Przykłady:
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

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML"
scim_status integer Określa, czy provisioning SCIM dla SAML jest włączony czy wyłączony.

Możliwe wartości:
0 - (domyślnie) Provisioning SCIM jest wyłączony;
1 - Provisioning SCIM jest włączony.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML"
sign_assertions integer Określa, czy asercje SAML powinny być podpisywane podpisem SAML.

Możliwe wartości:
0 - (domyślnie) Nie podpisuj asercji;
1 - Podpisuj asercje.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML"
sign_authn_requests integer Określa, czy żądania AuthN SAML powinny być podpisywane podpisem SAML.

Możliwe wartości:
0 - (domyślnie) Nie podpisuj żądań AuthN;
1 - Podpisuj żądania AuthN.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML"
sign_messages integer Określa, czy komunikaty SAML powinny być podpisywane podpisem SAML.

Możliwe wartości:
0 - (domyślnie) Nie podpisuj komunikatów;
1 - Podpisuj komunikaty.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML"
sign_logout_requests integer Określa, czy żądania wylogowania SAML powinny być podpisywane podpisem SAML.

Możliwe wartości:
0 - (domyślnie) Nie podpisuj żądań wylogowania;
1 - Podpisuj żądania wylogowania.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML"
sign_logout_responses integer Określa, czy odpowiedzi wylogowania SAML powinny być podpisywane podpisem SAML.

Możliwe wartości:
0 - (domyślnie) Nie podpisuj odpowiedzi wylogowania;
1 - Podpisuj odpowiedzi wylogowania.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML"
idp_certificate string Zawartość certyfikatu Service Provider (SP) do konfiguracji usługi jednokrotnego logowania SAML (SSO).

Przykłady:
-----BEGIN CERTIFICATE-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7...
...more encoded data...
-----END CERTIFICATE-----

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML" i $SSO['CERT_STORAGE'] jest ustawione na database w zabbix.conf.php
- tylko do zapisu
sp_private_key string Zawartość klucza prywatnego Service Provider (SP) do konfiguracji usługi jednokrotnego logowania SAML (SSO).
Zapewnia bezpieczne uwierzytelnianie i wymianę danych z dostawcą tożsamości (IdP).

Przykłady:
-----BEGIN CERTIFICATE-----
MIIEvQIBADANBgkqhkiG9w0BA...
...more encoded data...
-----END CERTIFICATE-----

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML" i $SSO['CERT_STORAGE'] jest ustawione na database w zabbix.conf.php
- tylko do zapisu
sp_certificate string Zawartość certyfikatu Service Provider (SP) do konfiguracji usługi jednokrotnego logowania SAML (SSO).

Przykłady:
-----BEGIN CERTIFICATE-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7...
...more encoded data...
-----END CERTIFICATE-----

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML" i $SSO['CERT_STORAGE'] jest ustawione na database w zabbix.conf.php
- tylko do zapisu
idp_certificate_hash string Skrót md5 wartości idp_certificate. Zwraca pusty ciąg dla pustego idp_certificate.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML" i $SSO['CERT_STORAGE'] jest ustawione na database w zabbix.conf.php
- tylko do odczytu
sp_private_key_hash string Skrót md5 wartości sp_private_key. Zwraca pusty ciąg dla pustego sp_private_key.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML" i $SSO['CERT_STORAGE'] jest ustawione na database w zabbix.conf.php
- tylko do odczytu
sp_certificate_hash string Skrót md5 wartości sp_certificate. Zwraca pusty ciąg dla pustego sp_certificate.

Zachowanie właściwości:
- obsługiwane, jeśli idp_type jest ustawione na "User directory of type SAML" i $SSO['CERT_STORAGE'] jest ustawione na database w zabbix.conf.php
- tylko do odczytu

Mapowania typów mediów

Obiekt mapowań typów mediów ma następujące właściwości.

Właściwość Typ Opis
userdirectory_mediaid ID ID mapowania typu mediów.

Zachowanie właściwości:
- tylko do odczytu
name string Widoczna nazwa na liście mapowań typów mediów.

Zachowanie właściwości:
- wymagane
mediatypeid ID ID typu mediów, który ma zostać utworzony; używane jako wartość właściwości mediatypeid obiektu Media.

Zachowanie właściwości:
- wymagane
attribute string Atrybut katalogu użytkowników LDAP/SAML (również atrybut SCIM, jeśli scim_status jest ustawione na „Udostępnianie SCIM jest włączone”), który zawiera media użytkownika (np. [email protected]), używane jako wartość właściwości sendto obiektu Media.

Jeśli występuje w danych otrzymanych od dostawcy tożsamości LDAP/SAML, a wartość nie jest pusta, spowoduje to utworzenie mediów dla udostępnionego użytkownika.

Zachowanie właściwości:
- wymagane
active integer Wartość właściwości active mediów użytkownika podczas tworzenia mediów dla udostępnionego użytkownika.

Możliwe wartości:
0 - (domyślnie) włączone;
1 - wyłączone.
severity integer Wartość właściwości severity mediów użytkownika podczas tworzenia mediów dla udostępnionego użytkownika.

Domyślnie: 63.
period string Wartość właściwości period mediów użytkownika podczas tworzenia mediów dla udostępnionego użytkownika.

Domyślnie: 1-7,00:00-24:00.

Mapowania grup provisioningu

Mapowania grup provisioningu mają następujące właściwości.

Właściwość Typ Opis
name string Pełna nazwa grupy (np. Zabbix administrators) w katalogu użytkowników LDAP/SAML (również SCIM, jeśli scim_status jest ustawione na „SCIM provisioning is enabled”).
Obsługuje znak wieloznaczny „*”.
Unikalna wśród wszystkich mapowań grup provisioningu.

Zachowanie właściwości:
- wymagane
roleid ID ID roli użytkownika, która ma zostać przypisana użytkownikowi.

Jeśli dopasowanych zostanie wiele mapowań grup provisioningu, użytkownikowi zostanie przypisana rola o najwyższym typie użytkownika (User, Admin lub Super admin). Jeśli istnieje wiele ról z tym samym typem użytkownika, użytkownikowi zostanie przypisana pierwsza rola (posortowana alfabetycznie).

Zachowanie właściwości:
- wymagane
user_groups array Tablica obiektów ID grup użytkowników Zabbix. Każdy obiekt ma następujące właściwości:
usrgrpid - (ID) ID grupy użytkowników Zabbix, która ma zostać przypisana użytkownikowi.

Jeśli dopasowanych zostanie wiele mapowań grup provisioningu, użytkownikowi zostaną przypisane grupy użytkowników Zabbix ze wszystkich dopasowanych mapowań.

Zachowanie właściwości:
- wymagane