Lietotāju direktorija objekts

Tālāk norādītie objekti ir tieši saistīti ar userdirectory API.

Lietotāju direktorijs

Lietotāju direktorija objektam ir šādas īpašības.

Īpašība Tips Apraksts
userdirectoryid ID Lietotāju direktorija ID.

Ja lietotāju direktorijs tiek dzēsts, User object īpašības userdirectoryid vērtība tiek iestatīta uz "0" visiem lietotājiem, kas ir saistīti ar dzēsto lietotāju direktoriju.

Īpašības darbība:
- tikai lasāms
- obligāts atjaunināšanas operācijām
idp_type integer Autentifikācijas protokola tips, ko identitātes nodrošinātājs izmanto lietotāju direktorijam.
Ņemiet vērā, ka var pastāvēt tikai viens SAML tipa lietotāju direktorijs.

Iespējamās vērtības:
1 - LDAP tipa lietotāju direktorijs;
2 - SAML tipa lietotāju direktorijs.

Īpašības darbība:
- obligāts izveides operācijām
group_name string LDAP/SAML lietotāju direktorija atribūts, kas satur grupas nosaukumu, ko izmanto grupu kartēšanai starp LDAP/SAML lietotāju direktoriju un Zabbix.

Piemērs: cn

Īpašības darbība:
- obligāts, ja provision_status ir iestatīts uz "Enabled" un Authentication object saml_jit_status ir iestatīts uz "Enabled for configured SAML IdPs"
user_username string LDAP/SAML lietotāju direktorija atribūts (arī SCIM atribūts, ja scim_status ir iestatīts uz "SCIM provisioning is enabled"), kas satur lietotāja vārdu un tiek izmantots kā User object īpašības name vērtība, kad lietotājs tiek provisionēts.

Piemēri: cn, commonName, displayName, name
user_lastname string LDAP/SAML lietotāju direktorija atribūts (arī SCIM atribūts, ja scim_status ir iestatīts uz "SCIM provisioning is enabled"), kas satur lietotāja uzvārdu un tiek izmantots kā User object īpašības surname vērtība, kad lietotājs tiek provisionēts.

Piemēri: sn, surname, lastName
provision_status integer Lietotāju direktorija provisionēšanas statuss.

Iespējamās vērtības:
0 - (noklusējums) Atspējots (šī lietotāju direktorija izveidoto lietotāju provisionēšana ir atspējota);
1 - Iespējots (šī lietotāju direktorija izveidoto lietotāju provisionēšana ir iespējota; papildus tam jābūt iespējotam LDAP vai SAML provisionēšanas statusam (ldap_jit_status vai Authentication object saml_jit_status)).
provision_groups array Provisionēšanas grupu kartējumu objektu masīvs LDAP/SAML lietotāju grupu šablona kartēšanai uz Zabbix lietotāju grupu un lietotāja lomu.

Īpašības darbība:
- obligāts, ja provision_status ir iestatīts uz "Enabled"
provision_media array Mediju tipu kartējumu objektu masīvs lietotāja LDAP/SAML mediju atribūtu (piemēram, e-pasta) kartēšanai uz Zabbix lietotāja medijiem paziņojumu sūtīšanai.
LDAP-specifiskas īpašības:
name string Unikāls lietotāju direktorija nosaukums.

Īpašības darbība:
- obligāts, ja idp_type ir iestatīts uz "User directory of type LDAP"
host string LDAP servera resursdatora nosaukums, IP vai URI.
URI jāietver shēma (ldap:// vai ldaps://), hosts un ports (nav obligāts).

Piemēri:
host.example.com
127.0.0.1
ldap://ldap.example.com:389

Īpašības darbība:
- obligāts, ja idp_type ir iestatīts uz "User directory of type LDAP"
port integer LDAP servera ports.

Īpašības darbība:
- obligāts, ja idp_type ir iestatīts uz "User directory of type LDAP"
base_dn string LDAP lietotāju direktorija bāzes ceļš uz lietotāju kontiem.

Piemēri:
ou=Users,dc=example,dc=org
ou=Users,ou=system (OpenLDAP gadījumā)
DC=company,DC=com (Microsoft Active Directory gadījumā)
uid=%{user},dc=example,dc=com (tiešai lietotāja piesaistei; vietturis "%{user}" ir obligāts)

Īpašības darbība:
- obligāts, ja idp_type ir iestatīts uz "User directory of type LDAP"
search_attribute string LDAP lietotāju direktorija atribūts, pēc kura identificēt lietotāja kontu no pieteikšanās pieprasījumā sniegtās informācijas.

Piemēri:
uid (OpenLDAP gadījumā)
sAMAccountName (Microsoft Active Directory gadījumā)

Īpašības darbība:
- obligāts, ja idp_type ir iestatīts uz "User directory of type LDAP"
bind_dn string LDAP servera konts piesaistei un meklēšanai LDAP serverī.

Tiešas lietotāja piesaistes un anonīmas piesaistes gadījumā bind_dn jābūt tukšam.

Piemēri:
uid=ldap_search,ou=system (OpenLDAP gadījumā)
CN=ldap_search,OU=user_group,DC=company,DC=com (Microsoft Active Directory gadījumā)
CN=Admin,OU=Users,OU=Zabbix,DC=zbx,DC=local

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type LDAP"
bind_password string LDAP parole kontam, ko izmanto piesaistei un meklēšanai LDAP serverī.

Tiešas lietotāja piesaistes un anonīmas piesaistes gadījumā bind_password jābūt tukšai.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type LDAP"
description string Lietotāju direktorija apraksts.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type LDAP"
group_basedn string LDAP lietotāju direktorija bāzes ceļš uz grupām; izmanto, lai konfigurētu lietotāja dalības pārbaudi LDAP lietotāju direktorijā.

Tiek ignorēts, provisionējot lietotāju, ja ir iestatīts group_membership.

Piemērs: ou=Groups,dc=example,dc=com

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type LDAP"
group_filter string Filtra virkne LDAP lietotāju direktorija grupu iegūšanai, kuru dalībnieks ir lietotājs; izmanto, lai konfigurētu lietotāja dalības pārbaudi LDAP lietotāju direktorijā.

Tiek ignorēts, provisionējot lietotāju, ja ir iestatīts group_membership.

Atbalstītie group_filter vietturi:
%{attr} - meklēšanas atribūts (aizstāts ar īpašības search_attribute vērtību);
%{groupattr} - grupas atribūts (aizstāts ar īpašības group_member vērtību);
%{host} - LDAP servera resursdatora nosaukums, IP vai URI (aizstāts ar īpašības host vērtību);
%{user} - Zabbix lietotāja lietotājvārds.

Noklusējums: (%{groupattr}=%{user})

Piemēri:
- (member=uid=%{ref},ou=Users,dc=example,dc=com) atbildīs "User1", ja LDAP grupas objekts satur atribūtu "member" ar vērtību "uid=User1,ou=Users,dc=example,dc=com", un atgriezīs grupu, kuras dalībnieks ir "User1";
- (%{groupattr}=cn=%{ref},ou=Users,ou=Zabbix,DC=example,DC=com) atbildīs "User1", ja LDAP grupas objekts satur atribūtu, kas norādīts īpašībā group_member, ar vērtību "cn=User1,ou=Users,ou=Zabbix,DC=example,DC=com", un atgriezīs grupu, kuras dalībnieks ir "User1".

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type LDAP"
group_member string LDAP lietotāju direktorija atribūts, kas satur informāciju par grupas dalībniekiem; izmanto, lai konfigurētu lietotāja dalības pārbaudi LDAP lietotāju direktorijā.

Tiek ignorēts, provisionējot lietotāju, ja ir iestatīts group_membership.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type LDAP"
group_membership string LDAP lietotāju direktorija atribūts, kas satur informāciju par grupām, kurām lietotājs pieder.

Piemērs: memberOf

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type LDAP"
search_filter string Pielāgota filtra virkne, ko izmanto lietotāja atrašanai un autentificēšanai LDAP lietotāju direktorijā, pamatojoties uz pieteikšanās pieprasījumā sniegto informāciju.

Atbalstītie search_filter vietturi:
%{attr} - meklēšanas atribūta nosaukums (piemēram, uid, sAMAccountName);
%{user} - Zabbix lietotāja lietotājvārds.

Noklusējums: (%{attr}=%{user})

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type LDAP"
start_tls integer LDAP servera konfigurācijas opcija, kas ļauj nodrošināt saziņu ar LDAP serveri, izmantojot Transport Layer Security (TLS).

Ņemiet vērā, ka start_tls jābūt iestatītam uz "Disabled" hostiem, kas izmanto ldaps:// protokolu.

Iespējamās vērtības:
0 - (noklusējums) Atspējots;
1 - Iespējots.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type LDAP"
user_ref_attr string LDAP lietotāju direktorija atribūts, ko izmanto atsaucei uz lietotāja objektu. user_ref_attr vērtība tiek izmantota, lai iegūtu vērtības no norādītā atribūta lietotāju direktorijā un ievietotu tās %{ref} viettura vietā group_filter virknē.

Piemēri: cn, uid, member, uniqueMember

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type LDAP"
SAML-specifiskas īpašības:
idp_entityid string URI, kas identificē identitātes nodrošinātāju un tiek izmantots saziņai ar identitātes nodrošinātāju SAML ziņojumos.

Piemērs: https://idp.example.com/idp

Īpašības darbība:
- obligāts, ja idp_type ir iestatīts uz "User directory of type SAML"
sp_entityid string URL vai jebkura virkne, kas identificē identitātes nodrošinātāja pakalpojuma sniedzēju.

Piemēri:
https://idp.example.com/sp
zabbix

Īpašības darbība:
- obligāts, ja idp_type ir iestatīts uz "User directory of type SAML"
username_attribute string SAML lietotāju direktorija atribūts (arī SCIM atribūts, ja scim_status ir iestatīts uz "SCIM provisioning is enabled"), kas satur lietotāja lietotājvārdu un autentificēšanas laikā tiek salīdzināts ar User object īpašības username vērtību.

Piemēri: 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

Īpašības darbība:
- obligāts, ja idp_type ir iestatīts uz "User directory of type SAML"
sso_url string Identitātes nodrošinātāja SAML vienotās pierakstīšanās pakalpojuma URL, uz kuru Zabbix sūtīs SAML autentifikācijas pieprasījumus.

Piemērs: http://idp.example.com/idp/sso/saml

Īpašības darbība:
- obligāts, ja idp_type ir iestatīts uz "User directory of type SAML"
slo_url string Identitātes nodrošinātāja SAML vienotās izrakstīšanās pakalpojuma URL, uz kuru Zabbix sūtīs SAML atteikšanās pieprasījumus.

Piemērs: https://idp.example.com/idp/slo/saml

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
encrypt_nameid integer Vai SAML name ID ir jāšifrē.

Iespējamās vērtības:
0 - (noklusējums) Nešifrēt name ID;
1 - Šifrēt name ID.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
encrypt_assertions integer Vai SAML apgalvojumi ir jāšifrē.

Iespējamās vērtības:
0 - (noklusējums) Nešifrēt apgalvojumus;
1 - Šifrēt apgalvojumus.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
nameid_format string SAML identitātes nodrošinātāja pakalpojuma sniedzēja Name ID formāts.

Piemēri:
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

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
scim_status integer Vai SAML SCIM provisionēšana ir iespējota vai atspējota.

Iespējamās vērtības:
0 - (noklusējums) SCIM provisionēšana ir atspējota;
1 - SCIM provisionēšana ir iespējota.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
sign_assertions integer Vai SAML apgalvojumi ir jāparaksta ar SAML parakstu.

Iespējamās vērtības:
0 - (noklusējums) Neparakstīt apgalvojumus;
1 - Parakstīt apgalvojumus.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
sign_authn_requests integer Vai SAML AuthN pieprasījumi ir jāparaksta ar SAML parakstu.

Iespējamās vērtības:
0 - (noklusējums) Neparakstīt AuthN pieprasījumus;
1 - Parakstīt AuthN pieprasījumus.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
sign_messages integer Vai SAML ziņojumi ir jāparaksta ar SAML parakstu.

Iespējamās vērtības:
0 - (noklusējums) Neparakstīt ziņojumus;
1 - Parakstīt ziņojumus.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
sign_logout_requests integer Vai SAML atteikšanās pieprasījumi ir jāparaksta ar SAML parakstu.

Iespējamās vērtības:
0 - (noklusējums) Neparakstīt atteikšanās pieprasījumus;
1 - Parakstīt atteikšanās pieprasījumus.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
sign_logout_responses integer Vai SAML atteikšanās atbildes ir jāparaksta ar SAML parakstu.

Iespējamās vērtības:
0 - (noklusējums) Neparakstīt atteikšanās atbildes;
1 - Parakstīt atteikšanās atbildes.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
idp_certificate string Service Provider (SP) sertifikāta saturs SAML vienotās pierakstīšanās (SSO) pakalpojuma iestatīšanai.

Piemēri:
-----BEGIN CERTIFICATE-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7...
...more encoded data...
-----END CERTIFICATE-----

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML" un zabbix.conf.php failā $SSO['CERT_STORAGE'] ir iestatīts uz database
- tikai rakstāms
sp_private_key string Service Provider (SP) privātās atslēgas saturs SAML vienotās pierakstīšanās (SSO) pakalpojuma iestatīšanai.
Nodrošina drošu autentifikāciju un datu apmaiņu ar identitātes nodrošinātāju (IdP).

Piemēri:
-----BEGIN CERTIFICATE-----
MIIEvQIBADANBgkqhkiG9w0BA...
...more encoded data...
-----END CERTIFICATE-----

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML" un zabbix.conf.php failā $SSO['CERT_STORAGE'] ir iestatīts uz database
- tikai rakstāms
sp_certificate string Service Provider (SP) sertifikāta saturs SAML vienotās pierakstīšanās (SSO) pakalpojuma iestatīšanai.

Piemēri:
-----BEGIN CERTIFICATE-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7...
...more encoded data...
-----END CERTIFICATE-----

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML" un zabbix.conf.php failā $SSO['CERT_STORAGE'] ir iestatīts uz database
- tikai rakstāms
idp_certificate_hash string idp_certificate vērtības md5 jaucējvērtība. Tukšam idp_certificate tiks atgriezta tukša virkne.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML" un zabbix.conf.php failā $SSO['CERT_STORAGE'] ir iestatīts uz database
- tikai lasāms
sp_private_key_hash string sp_private_key vērtības md5 jaucējvērtība. Tukšam sp_private_key tiks atgriezta tukša virkne.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML" un zabbix.conf.php failā $SSO['CERT_STORAGE'] ir iestatīts uz database
- tikai lasāms
sp_certificate_hash string sp_certificate vērtības md5 jaucējvērtība. Tukšam sp_certificate tiks atgriezta tukša virkne.

Īpašības darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML" un zabbix.conf.php failā $SSO['CERT_STORAGE'] ir iestatīts uz database
- tikai lasāms

Mediju tipu kartējumi

Mediju tipu kartējumu objektam ir šādas īpašības.

Īpašība Type Apraksts
userdirectory_mediaid ID Mediju tipu kartējuma ID.

Īpašības darbība:
- tikai lasāms
name string Sarakstā redzamais mediju tipu kartējuma nosaukums.

Īpašības darbība:
- obligāts
mediatypeid ID Izveidojamā mediju tipa ID; tiek izmantots kā Media object īpašības mediatypeid vērtība.

Īpašības darbība:
- obligāts
attribute string LDAP/SAML lietotāju direktorija atribūts (arī SCIM atribūts, ja scim_status ir iestatīts uz "SCIM provisioning is enabled"), kas satur lietotāja mediju (piemēram, [email protected]), un tas tiek izmantots kā Media object īpašības sendto vērtība.

Ja tas ir ietverts no LDAP/SAML identitātes nodrošinātāja saņemtajos datos un vērtība nav tukša, tas izraisīs medija izveidi nodrošinātajam lietotājam.

Īpašības darbība:
- obligāts
active integer Lietotāja medija īpašības active vērtība, kad medijs tiek izveidots nodrošinātajam lietotājam.

Iespējamās vērtības:
0 - (noklusējums) iespējots;
1 - atspējots.
severity integer Lietotāja medija īpašības severity vērtība, kad medijs tiek izveidots nodrošinātajam lietotājam.

Noklusējums: 63.
period string Lietotāja medija īpašības period vērtība, kad medijs tiek izveidots nodrošinātajam lietotājam.

Noklusējums: 1-7,00:00-24:00.

Provisionēšanas grupu kartējumi

Provisionēšanas grupu kartējumiem ir šādas īpašības.

Īpašība Type Apraksts
name string Pilns grupas nosaukums (piemēram, Zabbix administrators) LDAP/SAML lietotāju direktorijā (arī SCIM, ja scim_status ir iestatīts uz "SCIM provisioning is enabled").
Atbalsta aizstājējzīmi "*".
Unikāls visos provisionēšanas grupu kartējumos.

Īpašības darbība:
- required
roleid ID Lietotājam piešķiramās lietotāja lomas ID.

Ja atbilst vairāki provisionēšanas grupu kartējumi, lietotājam tiek piešķirta loma ar augstāko lietotāja tipu (User, Admin vai Super admin). Ja ir vairākas lomas ar vienādu lietotāja tipu, lietotājam tiek piešķirta pirmā loma (sakārtota alfabētiskā secībā).

Īpašības darbība:
- required
user_groups array Zabbix lietotāju grupu ID objektu masīvs. Katram objektam ir šādas īpašības:
usrgrpid - (ID) lietotājam piešķiramās Zabbix lietotāju grupas ID.

Ja atbilst vairāki provisionēšanas grupu kartējumi, lietotājam tiek piešķirtas visu atbilstošo kartējumu Zabbix lietotāju grupas.

Īpašības darbība:
- required