[comment]: # aside:1
[comment]: # ({c9088bab-f9e8f670})
# Lietotāju direktorija objekts
Tālāk norādītie objekti ir tieši saistīti ar `userdirectory` API.
[comment]: # ({/c9088bab-f9e8f670})
[comment]: # ({4529ab95-ad144502})
### Lietotāju direktorijs
Lietotāju direktorija objektam ir šādas īpašības.
|Īpašība|[Tips](/manual/api/reference_commentary#data-types)|Apraksts|
|--|--|------|
|userdirectoryid|ID|Lietotāju direktorija ID.
Ja lietotāju direktorijs tiek dzēsts, [Lietotāja objekta](/manual/api/reference/user/object#user) ī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](/manual/api/reference_commentary#property-behavior):
- *tikai lasāma*
- *obligāta* atjaunināšanas operācijām|
|idp_type|integer|Lietotāju direktorijā izmantotā autentifikācijas protokola tips, ko izmanto identitātes nodrošinātājs.
Ņ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 uzvedība](/manual/api/reference_commentary#property-behavior):
- *obligāta* 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 uzvedība](/manual/api/reference_commentary#property-behavior):
- *obligāta* ja `provision_status` ir iestatīts uz "Enabled" un [Autentifikācijas objekta](/manual/api/reference/authentication/object#authentication) `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, kas tiek izmantots kā [Lietotāja objekta](/manual/api/reference/user/object#user) ī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 direktorija atribūts (arī SCIM atribūts, ja `scim_status` ir iestatīts uz "SCIM provisioning is enabled"), kas satur lietotāja uzvārdu, kas tiek izmantots kā [Lietotāja objekta](/manual/api/reference/user/object#user) īpašības `surname` vērtība, kad lietotājs tiek nodrošināts.
Piemēri: *sn*, *surname*, *lastName*|
|provision_status|integer|Lietotāju direktorija nodrošināšanas statuss.
Iespējamās vērtības:
0 - *(noklusējums)* Atspējots (šī lietotāju direktorija izveidoto lietotāju nodrošināšana ir atspējota);
1 - Iespējots (šī lietotāju direktorija 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](/manual/api/reference/authentication/object#authentication))).|
|provision_groups|array|[Nodrošināšanas grupu kartējumu](object#provisioning-groups-mappings) objektu masīvs LDAP/SAML lietotāju grupas parauga kartēšanai uz Zabbix lietotāju grupu un lietotāja lomu.
[Īpašības uzvedība](/manual/api/reference_commentary#property-behavior):
- *obligāta* ja `provision_status` ir iestatīts uz "Enabled"|
|provision_media|array|[Multivides tipu kartējumu](object#media-type-mappings) 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](/manual/web_interface/frontend_sections/users/authentication/ldap)-specifiskās īpašības:**|<|<|
|name|string|Lietotāju direktorija unikālais nosaukums.
[Īpašības uzvedība](/manual/api/reference_commentary#property-behavior):
- *obligāta* 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://`), resursdators un ports (neobligāti).
Piemēri:
*host.example.com*
*127.0.0.1*
*ldap://ldap.example.com:389*
[Īpašības uzvedība](/manual/api/reference_commentary#property-behavior):
- *obligāta* ja `idp_type` ir iestatīts uz "User directory of type LDAP"|
|port|integer|LDAP servera ports.
[Īpašības uzvedība](/manual/api/reference_commentary#property-behavior):
- *obligāta* 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 uzvedība](/manual/api/reference_commentary#property-behavior):
- *obligāta* 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, 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](/manual/api/reference_commentary#property-behavior):
- *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š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 uzvedība](/manual/api/reference_commentary#property-behavior):
- *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šas lietotāja piesaistes un anonīmas piesaistes gadījumā `bind_password` jābūt tukšam.
[Īpašības uzvedība](/manual/api/reference_commentary#property-behavior):
- *atbalstīta* ja `idp_type` ir iestatīts uz "User directory of type LDAP"|
|description|string|Lietotāju direktorija apraksts.
[Īpašības uzvedība](/manual/api/reference_commentary#property-behavior):
- *atbalstīta* 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 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](/manual/api/reference_commentary#property-behavior):
- *atbalstīta* ja `idp_type` ir iestatīts uz "User directory of type LDAP"|
|group_filter|string|Filtra virkne LDAP lietotāju direktorija grupu, kuru lietotājs ir dalībnieks, 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 adrese 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 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 `group_member` īpašībā norādīto atribūtu 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](/manual/api/reference_commentary#property-behavior):
- *atbalstīta* 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 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](/manual/api/reference_commentary#property-behavior):
- *atbalstīta* 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 uzvedība](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *atbalstīta* ja `idp_type` ir iestatīts uz "User directory of type LDAP"|
|start_tls|integer|LDAP servera konfigurācijas opcija, kas ļauj saziņu ar LDAP serveri aizsargāt, 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 uzvedība](/manual/api/reference_commentary#property-behavior):
- *atbalstīta* ja `idp_type` ir iestatīts uz "User directory of type LDAP"|
|user_ref_attr|string|LDAP lietotāju direktorija 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 vietā *%{ref}* vietturim `group_filter` virknē.
Piemēri: *cn*, *uid*, *member*, *uniqueMember*
[Īpašības uzvedība](/manual/api/reference_commentary#property-behavior):
- *atbalstīta* ja `idp_type` ir iestatīts uz "User directory of type LDAP"|
|**[SAML](/manual/web_interface/frontend_sections/users/authentication/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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *obligāta* 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, kas autentificēšanas laikā tiek salīdzināts ar [Lietotāja objekta](/manual/api/reference/user/object#user) ī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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *atbalstīta* ja `idp_type` ir iestatīts uz "User directory of type SAML"|
|scim_status|integer|Vai SCIM nodrošināšana SAML 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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *atbalstīta* ja `idp_type` ir iestatīts uz "User directory of type SAML"|
[comment]: # ({/4529ab95-ad144502})
[comment]: # ({07d3d820-c2b51996})
#### Mediju tipu kartējumi
Mediju tipu kartējumu objektam ir šādas īpašības.
|Īpašība|[Type](/manual/api/reference_commentary#data-types)|Apraksts|
|--|--|----------------|
|userdirectory_mediaid|ID|Mediju tipu kartējuma ID.
[Īpašības darbība](/manual/api/reference_commentary#property-behavior):
- *tikai lasāms*|
|name|string|Sarakstā redzamais mediju tipu kartējuma nosaukums.
[Īpašības darbība](/manual/api/reference_commentary#property-behavior):
- *obligāts*|
|mediatypeid|ID|Izveidojamā mediju tipa ID; tiek izmantots kā [Media object](/manual/api/reference/user/object#media) īpašības `mediatypeid` vērtība.
[Īpašības darbība](/manual/api/reference_commentary#property-behavior):
- *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, *user@example.com*), un tas tiek izmantots kā [Media object](/manual/api/reference/user/object#media) ī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](/manual/api/reference_commentary#property-behavior):
- *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.|
[comment]: # ({/07d3d820-c2b51996})
[comment]: # ({fe544518-67bd0ce1})
#### Provisionēšanas grupu kartējumi
Provisionēšanas grupu kartējumiem ir šādas īpašības.
|Īpašība|[Type](/manual/api/reference_commentary#data-types)|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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *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](/manual/api/reference_commentary#property-behavior):
- *required*|
[comment]: # ({/fe544518-67bd0ce1})