Lietotāju direktorija objekts

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

Lietotāju direktorija

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

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

Ja lietotāju direktorija tiek dzēsta, Lietotāja objekta īpašības userdirectoryid vērtība visiem lietotājiem, kas ir saistīti ar dzēsto lietotāju direktoriju, tiek iestatīta uz "0".

Īpašības uzvedība:
- tikai lasāma
- obligāta atjaunināšanas darbībām
idp_type integer Lietotāja direktorijā izmantotā identitātes nodrošinātāja autentifikācijas protokola tips.
Ņemiet vērā, ka var pastāvēt tikai viena SAML tipa lietotāju direktorija.

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

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

Piemērs: cn

Īpašības uzvedība:
- obligāta ja provision_status ir iestatīts uz "Enabled" un Autentifikācijas objekta saml_jit_status ir iestatīts uz "Enabled for configured SAML IdPs"
user_username string LDAP/SAML lietotāju direktorijas atribūts (arī SCIM atribūts, ja scim_status ir iestatīts uz "SCIM provisioning is enabled"), kas satur lietotāja vārdu, kurš tiek izmantots kā Lietotāja objekta īpašības name vērtība, kad lietotājs tiek nodrošināts.

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

Piemēri: sn, surname, lastName
provision_status integer Lietotāju direktorijas nodrošināšanas statuss.

Iespējamās vērtības:
0 - (noklusējums) Atspējots (šīs lietotāju direktorijas izveidoto lietotāju nodrošināšana ir atspējota);
1 - Iespējots (šīs lietotāju direktorijas izveidoto lietotāju nodrošināšana ir iespējota; papildus tam jābūt iespējotam LDAP vai SAML nodrošināšanas statusam (ldap_jit_status vai saml_jit_status no Autentifikācijas objekta)).
provision_groups array Nodrošināšanas grupu kartējumu objektu masīvs LDAP/SAML lietotāju grupas parauga kartēšanai uz Zabbix lietotāju grupu un lietotāja lomu.

Īpašības uzvedība:
- obligāta ja provision_status ir iestatīts uz "Enabled"
provision_media array Multivides tipu kartējumu objektu masīvs lietotāja LDAP/SAML multivides atribūtu (piem., e-pasta) kartēšanai uz Zabbix lietotāja multividi paziņojumu sūtīšanai.
LDAP-specifiskās īpašības: < <
name string Lietotāju direktorijas unikālais nosaukums.

Īpašības uzvedība:
- obligāta 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://), resursdators un ports (neobligāti).

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

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

Īpašības uzvedība:
- obligāta ja idp_type ir iestatīts uz "User directory of type LDAP"
base_dn string LDAP lietotāju direktorijas 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 uzvedība:
- obligāta ja idp_type ir iestatīts uz "User directory of type LDAP"
search_attribute string LDAP lietotāju direktorijas atribūts, pēc kura identificēt lietotāja kontu, izmantojot pieteikšanās pieprasījumā sniegto informāciju.

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

Īpašības uzvedība:
- obligāta 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šai lietotāja piesaistei un anonīmai piesaistei 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 uzvedība:
- atbalstīta ja idp_type ir iestatīts uz "User directory of type LDAP"
bind_password string LDAP konta parole piesaistei un meklēšanai LDAP serverī.

Tiešai lietotāja piesaistei un anonīmai piesaistei bind_password jābūt tukšam.

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

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

Tiek ignorēts, nodrošinot lietotāju, ja ir iestatīts group_membership.

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

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

Tiek ignorēts, nodrošinot lietotāju, ja ir iestatīts group_membership.

Atbalstītie group_filter vietturi:
%{attr} - meklēšanas atribūts (aizstāts ar search_attribute īpašības vērtību);
%{groupattr} - grupas atribūts (aizstāts ar group_member īpašības vērtību);
%{host} - LDAP servera resursdatora nosaukums, IP vai URI (aizstāts ar host īpašības 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 objektā ir atribūts "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 objektā ir atribūts, kas norādīts group_member īpašībā, 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 uzvedība:
- atbalstīta ja idp_type ir iestatīts uz "User directory of type LDAP"
group_member string LDAP lietotāju direktorijas atribūts, kas satur informāciju par grupas dalībniekiem; tiek izmantots, lai konfigurētu lietotāja piederības pārbaudi LDAP lietotāju direktorijā.

Tiek ignorēts, nodrošinot lietotāju, ja ir iestatīts group_membership.

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

Piemērs: memberOf

Īpašības uzvedība:
- atbalstīta ja idp_type ir iestatīts uz "User directory of type LDAP"
search_filter string Pielāgota filtra virkne, ko izmanto, lai atrastu un autentificētu lietotāju 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., uid, sAMAccountName);
%{user} - Zabbix lietotāja lietotājvārds.

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

Īpašības uzvedība:
- atbalstīta 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āiestata uz "Disabled" hostiem, kas izmanto ldaps:// protokolu.

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

Īpašības uzvedība:
- atbalstīta ja idp_type ir iestatīts uz "User directory of type LDAP"
user_ref_attr string LDAP lietotāju direktorijas atribūts, ko izmanto, lai atsauktos 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 uzvedība:
- atbalstīta ja idp_type ir iestatīts uz "User directory of type LDAP"
SAML-specifiskās ī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 uzvedība:
- obligāta 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 pakalpojumu sniedzēju.

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

Īpašības uzvedība:
- obligāta ja idp_type ir iestatīts uz "User directory of type SAML"
username_attribute string SAML lietotāju direktorijas atribūts (arī SCIM atribūts, ja scim_status ir iestatīts uz "SCIM provisioning is enabled"), kas satur lietotāja lietotājvārdu, kurš autentificēšanas laikā tiek salīdzināts ar Lietotāja objekta ī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 uzvedība:
- obligāta ja idp_type ir iestatīts uz "User directory of type SAML"
sso_url string Identitātes nodrošinātāja SAML vienreizējā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 uzvedība:
- obligāta ja idp_type ir iestatīts uz "User directory of type SAML"		  
slo_url string Identitātes nodrošinātāja SAML vienreizējās atteikš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 uzvedība:
- atbalstīta 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 uzvedība:
- atbalstīta 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 uzvedība:
- atbalstīta ja idp_type ir iestatīts uz "User directory of type SAML"
nameid_format string SAML identitātes nodrošinātāja pakalpojumu 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 uzvedība:
- atbalstīta ja idp_type ir iestatīts uz "User directory of type SAML"
scim_status integer Vai SAML SCIM nodrošināšana ir iespējota vai atspējota.

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

Īpašības uzvedība:
- atbalstīta 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 uzvedība:
- atbalstīta 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 uzvedība:
- atbalstīta 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 uzvedība:
- atbalstīta 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 uzvedība:
- atbalstīta 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 uzvedība:
- atbalstīta ja idp_type ir iestatīts uz "User directory of type SAML"

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