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.

Property Type Description
userdirectoryid ID Identyfikator katalogu użytkowników.

Jeśli katalog użytkowników zostanie usunięty, wartość właściwości userdirectoryid obiektu User 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
- wymagana w operacjach aktualizacji
idp_type integer Typ protokołu uwierzytelniania używanego przez dostawcę tożsamości dla katalogu użytkowników.
Należy pamiętać, ż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:
- wymagana w operacjach 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 Zabbixem.

Przykład: cn

Zachowanie właściwości:
- wymagana, jeśli provision_status ma wartość „Enabled”, a saml_jit_status obiektu Authentication ma wartość „Enabled for configured SAML IdPs”
user_username string Atrybut katalogu użytkowników LDAP/SAML (również atrybut SCIM, jeśli scim_status ma wartość „SCIM provisioning is enabled”) zawierający nazwę użytkownika, która podczas aprowizacji użytkownika jest używana jako wartość właściwości name obiektu User.

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

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

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

Zachowanie właściwości:
- wymagana, jeśli provision_status ma wartość „Enabled”
provision_media array Tablica obiektów mapowań typów mediów służących do mapowania atrybutów mediów użytkownika LDAP/SAML (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:
- wymagana, jeśli idp_type ma wartość „User directory of type LDAP”
host string Nazwa hosta, adres IP lub URI serwera LDAP.
URI musi zawierać schemat (ldap:// lub ldaps://), host oraz opcjonalnie port.

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

Zachowanie właściwości:
- wymagana, jeśli idp_type ma wartość „User directory of type LDAP”
port integer Port serwera LDAP.

Zachowanie właściwości:
- wymagana, jeśli idp_type ma wartość „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 wymagany)

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

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

Zachowanie właściwości:
- wymagana, jeśli idp_type ma wartość „User directory of type LDAP”
bind_dn string Konto serwera LDAP używane do wiązania i wyszukiwania na 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ługiwana, jeśli idp_type ma wartość „User directory of type LDAP”
bind_password string Hasło LDAP konta używanego do wiązania i wyszukiwania na 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ługiwana, jeśli idp_type ma wartość „User directory of type LDAP”
description string Opis katalogu użytkowników.

Zachowanie właściwości:
- obsługiwana, jeśli idp_type ma wartość „User directory of type LDAP”
group_basedn string Ścieżka bazowa katalogu użytkowników LDAP do grup; używana do konfigurowania sprawdzania członkostwa użytkownika w katalogu użytkowników LDAP.

Ignorowana podczas aprowizacji użytkownika, jeśli ustawiono group_membership.

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

Zachowanie właściwości:
- obsługiwana, jeśli idp_type ma wartość „User directory of type LDAP”
group_filter string Ciąg filtra służący do pobierania grup katalogu użytkowników LDAP, których członkiem jest użytkownik; używany do konfigurowania sprawdzania członkostwa użytkownika w katalogu użytkowników LDAP.

Ignorowany podczas aprowizacji 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ępowany wartością właściwości host);
%{user} - nazwa użytkownika Zabbix.

Wartość domyślna: (%{groupattr}=%{user})

Przykłady:
- (member=uid=%{ref},ou=Users,dc=example,dc=com) dopasuje „User1”, jeśli obiekt grupy LDAP zawiera atrybut „member” z 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 z 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ługiwana, jeśli idp_type ma wartość „User directory of type LDAP”
group_member string Atrybut katalogu użytkowników LDAP zawierający informacje o członkach grupy; używany do konfigurowania sprawdzania członkostwa użytkownika w katalogu użytkowników LDAP.

Ignorowany podczas aprowizacji użytkownika, jeśli ustawiono group_membership.

Zachowanie właściwości:
- obsługiwana, jeśli idp_type ma wartość „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ługiwana, jeśli idp_type ma wartość „User directory of type LDAP”
search_filter string Niestandardowy ciąg filtra używany do zlokalizowania i uwierzytelnienia 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.

Wartość domyślna: (%{attr}=%{user})

Zachowanie właściwości:
- obsługiwana, jeśli idp_type ma wartość „User directory of type LDAP”
start_tls integer Opcja konfiguracji serwera LDAP umożliwiająca zabezpieczenie komunikacji z serwerem LDAP za pomocą protokołu Transport Layer Security (TLS).

Należy pamiętać, że dla hostów używających protokołu ldaps:// parametr start_tls musi mieć wartość „Disabled”.

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

Zachowanie właściwości:
- obsługiwana, jeśli idp_type ma wartość „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 służy 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ługiwana, jeśli idp_type ma wartość „User directory of type LDAP”
Właściwości specyficzne dla SAML:
idp_entityid string URI identyfikujący dostawcę tożsamości, używany do komunikacji z dostawcą tożsamości w komunikatach SAML.

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

Zachowanie właściwości:
- wymagana, jeśli idp_type ma wartość „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:
- wymagana, jeśli idp_type ma wartość „User directory of type SAML”
username_attribute string Atrybut katalogu użytkowników SAML (również atrybut SCIM, jeśli scim_status ma wartość „SCIM provisioning is enabled”) zawierający nazwę użytkownika, która podczas uwierzytelniania jest porównywana z wartością właściwości username obiektu User.

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:
- wymagana, jeśli idp_type ma wartość „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:
- wymagana, jeśli idp_type ma wartość „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ługiwana, jeśli idp_type ma wartość „User directory of type SAML”
encrypt_nameid integer Określa, czy identyfikator name ID SAML powinien być szyfrowany.

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

Zachowanie właściwości:
- obsługiwana, jeśli idp_type ma wartość „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ługiwana, jeśli idp_type ma wartość „User directory of type SAML”
nameid_format string Format name ID 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ługiwana, jeśli idp_type ma wartość „User directory of type SAML”
scim_status integer Określa, czy aprowizacja SCIM dla SAML jest włączona, czy wyłączona.

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

Zachowanie właściwości:
- obsługiwana, jeśli idp_type ma wartość „User directory of type SAML”
sign_assertions integer Określa, czy asercje SAML powinny być podpisywane podpisem SAML.

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

Zachowanie właściwości:
- obsługiwana, jeśli idp_type ma wartość „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 - Nie podpisuj żądań AuthN;
1 - (domyślnie) Podpisuj żądania AuthN.

Zachowanie właściwości:
- obsługiwana, jeśli idp_type ma wartość „User directory of type SAML”
sign_messages integer Określa, czy komunikaty SAML powinny być podpisywane podpisem SAML.

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

Zachowanie właściwości:
- obsługiwana, jeśli idp_type ma wartość „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 - Nie podpisuj żądań wylogowania;
1 - (domyślnie) Podpisuj żądania wylogowania.

Zachowanie właściwości:
- obsługiwana, jeśli idp_type ma wartość „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 - Nie podpisuj odpowiedzi wylogowania;
1 - (domyślnie) Podpisuj odpowiedzi wylogowania.

Zachowanie właściwości:
- obsługiwana, jeśli idp_type ma wartość „User directory of type SAML”

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