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 šādi rekvizīti.

Rekvizīts Tips Apraksts
userdirectoryid ID Lietotāju direktorija ID.

Ja lietotāju direktorijs tiek dzēsts, Lietotāja objekta rekvizīta userdirectoryid vērtība tiek iestatīta uz "0" visiem lietotājiem, kas ir saistīti ar dzēsto lietotāju direktoriju.

Rekvizīta darbība:
- tikai lasāms
- obligāts atjaunināšanas darbībām
idp_type integer Identitātes nodrošinātāja lietotāju direktorijam izmantotā autentifikācijas protokola tips.
Ņ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.

Rekvizīta darbība:
- obligāts izveides darbībā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

Rekvizīta darbība:
- obligāts, 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 direktorija atribūts (arī SCIM atribūts, ja scim_status ir iestatīts uz "SCIM provisioning is enabled"), kas satur lietotāja vārdu, kurš lietotāja nodrošināšanas laikā tiek izmantots kā Lietotāja objekta rekvizīta name vērtība.

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, kurš lietotāja nodrošināšanas laikā tiek izmantots kā Lietotāja objekta rekvizīta surname vērtība.

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

Iespējamās vērtības:
0 - (noklusējums) Disabled (lietotāju, kurus izveidojis šis lietotāju direktorijs, nodrošināšana ir atspējota);
1 - Enabled (lietotāju, kurus izveidojis šis lietotāju direktorijs, nodrošināšana ir iespējota; papildus jābūt iespējotam LDAP vai SAML nodrošināšanas statusam (ldap_jit_status vai Autentifikācijas objekta saml_jit_status)).
provision_groups array Nodrošināšanas grupu kartējumu objektu masīvs LDAP/SAML lietotāju grupu modeļa kartēšanai uz Zabbix lietotāju grupu un lietotāja lomu.

Rekvizīta darbība:
- obligāts, 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ēram, e-pasta) kartēšanai uz Zabbix lietotāja multividi paziņojumu nosūtīšanai.
LDAP specifiskie rekvizīti:
name string Unikāls lietotāju direktorija nosaukums.

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

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

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

Rekvizīta 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)
DC=company,DC=com (Microsoft Active Directory)
uid=%{user},dc=example,dc=com (tiešai lietotāja saistīšanai; vietturis "%{user}" ir obligāts)

Rekvizīta 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ē lietotāja kontu, izmantojot pieteikšanās pieprasījumā sniegto informāciju.

Piemēri:
uid (OpenLDAP)
sAMAccountName (Microsoft Active Directory)

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

Tiešai lietotāja saistīšanai un anonīmai saistīšanai bind_dn jābūt tukšam.

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

Rekvizīta darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type LDAP"
bind_password string LDAP parole kontam, kas tiek izmantots saistīšanai un meklēšanai LDAP serverī.

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

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

Rekvizīta 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; tiek izmantots, lai konfigurētu lietotāja dalības pārbaudi LDAP lietotāju direktorijā.

Tiek ignorēts lietotāja nodrošināšanas laikā, ja ir iestatīts group_membership.

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

Rekvizīta 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 izgūšanai, kurās lietotājs ir dalībnieks; tiek izmantota, lai konfigurētu lietotāja dalības pārbaudi LDAP lietotāju direktorijā.

Tiek ignorēta lietotāja nodrošināšanas laikā, ja ir iestatīts group_membership.

Atbalstītie group_filter vietturi:
%{attr} - meklēšanas atribūts (aizstāts ar rekvizīta search_attribute vērtību);
%{groupattr} - grupas atribūts (aizstāts ar rekvizīta group_member vērtību);
%{host} - LDAP servera resursdatora nosaukums, IP adrese vai URI (aizstāts ar rekvizīta 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, kurā "User1" ir dalībnieks;
- (%{groupattr}=cn=%{ref},ou=Users,ou=Zabbix,DC=example,DC=com) atbildīs "User1", ja LDAP grupas objekts satur rekvizītā group_member norādīto atribūtu ar vērtību "cn=User1,ou=Users,ou=Zabbix,DC=example,DC=com", un atgriezīs grupu, kurā "User1" ir dalībnieks.

Rekvizīta 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; tiek izmantots, lai konfigurētu lietotāja dalības pārbaudi LDAP lietotāju direktorijā.

Tiek ignorēts lietotāja nodrošināšanas laikā, ja ir iestatīts group_membership.

Rekvizīta 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

Rekvizīta 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})

Rekvizīta 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 aizsargā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) Disabled;
1 - Enabled.

Rekvizīta 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 lietotāja objekta atsaucei. user_ref_attr vērtība tiek izmantota, lai iegūtu vērtības no norādītā lietotāju direktorija atribūta un ievietotu tās viettura %{ref} vietā group_filter virknē.

Piemēri: cn, uid, member, uniqueMember

Rekvizīta darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type LDAP"
SAML specifiskie rekvizīti:
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

Rekvizīta 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 pakalpojumu sniedzēju.

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

Rekvizīta 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, kurš autentificēšanas laikā tiek salīdzināts ar Lietotāja objekta rekvizīta 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

Rekvizīta 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 pieteikšanās pakalpojuma URL, uz kuru Zabbix nosūtīs SAML autentifikācijas pieprasījumus.

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

Rekvizīta 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 atteikšanās pakalpojuma URL, uz kuru Zabbix nosūtīs SAML atteikšanās pieprasījumus.

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

Rekvizīta darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
encrypt_nameid integer Norāda, 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.

Rekvizīta darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
encrypt_assertions integer Norāda, vai SAML apgalvojumi ir jāšifrē.

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

Rekvizīta darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
nameid_format string Identitātes nodrošinātāja pakalpojumu sniedzēja SAML 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

Rekvizīta darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
scim_status integer Norāda, 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.

Rekvizīta darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
sign_assertions integer Norāda, vai SAML apgalvojumi jāparaksta ar SAML parakstu.

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

Rekvizīta darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
sign_authn_requests integer Norāda, vai SAML AuthN pieprasījumi jāparaksta ar SAML parakstu.

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

Rekvizīta darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
sign_messages integer Norāda, vai SAML ziņojumi jāparaksta ar SAML parakstu.

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

Rekvizīta darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
sign_logout_requests integer Norāda, vai SAML atteikšanās pieprasījumi jāparaksta ar SAML parakstu.

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

Rekvizīta darbība:
- atbalstīts, ja idp_type ir iestatīts uz "User directory of type SAML"
sign_logout_responses integer Norāda, vai SAML atteikšanās atbildes jāparaksta ar SAML parakstu.

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

Rekvizīta darbība:
- atbalstīts, 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