> Gebruikersdirectory-object

De volgende objecten hebben direct betrekking op de userdirectory API.

Gebruikersmap

Het gebruikersmap-object heeft de volgende eigenschappen.

Eigenschap	Type	Beschrijving
userdirectoryid	string	ID van de gebruikersmap. Als een gebruikersmap wordt verwijderd, wordt de waarde van de eigenschap `userdirectoryid` van het Gebruikersobject ingesteld op "0" voor alle gebruikers die gekoppeld zijn aan de verwijderde gebruikersmap. Gedrag van eigenschap: - alleen-lezen - vereist voor update-operaties
idp_type	int	Type van het authenticatieprotocol dat door de identiteitsprovider wordt gebruikt voor de gebruikersmap. Merk op dat er slechts één gebruikersmap van het type SAML kan bestaan. Mogelijke waarden: 1 - Gebruikersmap van het type LDAP; 2 - Gebruikersmap van het type SAML. Gedrag van eigenschap: - vereist voor maak-operaties
group_name	string	LDAP/SAML-gebruikersmapattribuut dat de naam van de groep bevat die wordt gebruikt om groepen tussen de LDAP/SAML-gebruikersmap en Zabbix te koppelen. Voorbeeld: cn Gedrag van eigenschap: - vereist als `provision_status` is ingesteld op "Ingeschakeld" en `saml_jit_status` van het Authenticatie-object is ingesteld op "Ingeschakeld voor geconfigureerde SAML IdP's"
user_username	string	LDAP/SAML-gebruikersmapattribuut (ook SCIM-attribuut als `scim_status` is ingesteld op "SCIM-provisioning is ingeschakeld") dat de naam van de gebruiker bevat die wordt gebruikt als waarde voor de eigenschap `name` van het Gebruikersobject wanneer de gebruiker wordt voorzien. Voorbeelden: cn, commonName, displayName, name
user_lastname	string	LDAP/SAML-gebruikersmapattribuut (ook SCIM-attribuut als `scim_status` is ingesteld op "SCIM-provisioning is ingeschakeld") dat de achternaam van de gebruiker bevat die wordt gebruikt als waarde voor de eigenschap `surname` van het Gebruikersobject wanneer de gebruiker wordt voorzien. Voorbeelden: sn, surname, lastName
provision_status	int	Voorzieningsstatus van de gebruikersmap. Mogelijke waarden: 0 - (standaard) Uitgeschakeld (voorlopige voorziening van gebruikers die door deze gebruikersmap zijn gemaakt, is uitgeschakeld); 1 - Ingeschakeld (voorlopige voorziening van gebruikers die door deze gebruikersmap zijn gemaakt, is ingeschakeld; bovendien moet de status van LDAP- of SAML-voorziening (`ldap_jit_status` of `saml_jit_status` van het Authenticatie-object) ingeschakeld zijn).
provision_groups	array	Array van voorziene groepsmappings-objecten voor het koppelen van LDAP/SAML-gebruikersgroeppatronen aan Zabbix-gebruikersgroep en gebruikersrol. Gedrag van eigenschap: - vereist als `provision_status` is ingesteld op "Ingeschakeld"
provision_media	array	Array van mediatype-mappings-objecten voor het koppelen van gebruikersmedia-attributen van LDAP/SAML (bijv. e-mail) aan Zabbix-gebruikersmedia voor het verzenden van meldingen.
LDAP-specifieke eigenschappen:
name	string	Unieke naam van de gebruikersmap. Gedrag van eigenschap: - vereist als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
host	string	Hostnaam, IP of URI van de LDAP-server. URI moet het schema (`ldap://` of `ldaps://`), de host en de poort bevatten (optioneel). Voorbeelden: host.example.com 127.0.0.1 ldap://ldap.example.com:389 Gedrag van eigenschap: - vereist als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
port	int	Poort van de LDAP-server. Gedrag van eigenschap: - vereist als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
base_dn	string	Basispad naar gebruikersaccounts van de LDAP-gebruikersmap. Voorbeelden: ou=Users,dc=example,dc=org ou=Users,ou=system (voor OpenLDAP) DC=bedrijf,DC=com (voor Microsoft Active Directory) uid=%{user},dc=example,dc=com (voor directe gebruikersbinding; plaatshouder "%{user}" is verplicht) Gedrag van eigenschap: - vereist als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
search_attribute	string	LDAP-gebruikersmapattribuut aan de hand waarvan het gebruikersaccount wordt geïdentificeerd aan de hand van de informatie in het aanmeldverzoek. Voorbeelden: uid (voor OpenLDAP) sAMAccountName (voor Microsoft Active Directory) Gedrag van eigenschap: - vereist als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
bind_dn	string	LDAP-serveraccount voor binden en zoeken op de LDAP-server. Voor directe gebruikersbinding en anonieme binding moet `bind_dn` leeg zijn. Voorbeelden: uid=ldap_search,ou=system (voor OpenLDAP) CN=ldap_search,OU=gebruikersgroep,DC=bedrijf,DC=com (voor Microsoft Active Directory) CN=Admin,OU=Users,OU=Zabbix,DC=zbx,DC=local Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
bind_password	string	LDAP-wachtwoord van het account voor binden en zoeken op de LDAP-server. Voor directe gebruikersbinding en anonieme binding moet `bind_password` leeg zijn. Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
description	string	Beschrijving van de gebruikersmap. Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
group_basedn	string	Basispad naar groepen van de LDAP-gebruikersmap; wordt gebruikt om een controle op gebruikerslidmaatschap te configureren in de LDAP-gebruikersmap. Genegeerd bij voorziening van een gebruiker als `group_membership` is ingesteld. Voorbeeld: ou=Groups,dc=example,dc=com Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
group_filter	string	Filtertekenreeks voor het ophalen van groepen van de LDAP-gebruikersmap waarvan de gebruiker lid is; wordt gebruikt om een controle op gebruikerslidmaatschap te configureren in de LDAP-gebruikersmap. Genegeerd bij voorziening van een gebruiker als `group_membership` is ingesteld. Ondersteunde plaatshouders voor `group_filter`: %{attr} - zoekattribuut (vervangen door de waarde van de eigenschap `search_attribute`); %{groupattr} - groepattribuut (vervangen door de waarde van de eigenschap `group_member`); %{host} - hostnaam, IP of URI van de LDAP-server (vervangen door de waarde van de eigenschap `host`); %{user} - Gebruikersnaam van Zabbix-gebruiker. Standaard: (%{groupattr}=%{user}) Voorbeelden: - (member=uid=%{ref},ou=Users,dc=example,dc=com) zal "Gebruiker1" overeenkomen als een LDAP-groepsobject het "member" attribuut bevat met de waarde "uid=Gebruiker1,ou=Users,dc=example,dc=com", en zal de groep retourneren waarvan "Gebruiker1" lid is; - (%{groupattr}=cn=%{ref},ou=Users,ou=Zabbix,DC=example,DC=com) zal "Gebruiker1" overeenkomen als een LDAP-groepsobject het attribuut bevat dat is gespecificeerd in de eigenschap `group_member` met de waarde "cn=Gebruiker1,ou=Users,ou=Zabbix,DC=example,DC=com", en zal de groep retourneren waarvan "Gebruiker1" lid is. Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
group_member	string	LDAP-gebruikersmapattribuut dat informatie bevat over de leden van de groep; wordt gebruikt om een controle op gebruikerslidmaatschap te configureren in de LDAP-gebruikersmap. Genegeerd bij voorziening van een gebruiker als `group_membership` is ingesteld. Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
group_membership	string	LDAP-gebruikersmapattribuut dat informatie bevat over de groepen waartoe een gebruiker behoort. Voorbeeld: memberOf Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
search_filter	string	Aangepaste filtertekenreeks die wordt gebruikt om een gebruiker te lokaliseren en te authenticeren in een LDAP-gebruikersmap op basis van de informatie in het aanmeldverzoek. Ondersteunde plaatshouders voor `search_filter`: %{attr} - naam van het zoekattribuut (bijv. uid, sAMAccountName); %{user} - Gebruikersnaam van Zabbix-gebruiker. Standaard: (%{attr}=%{user}) Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
start_tls	int	LDAP-serverconfiguratieoptie waarmee de communicatie met de LDAP-server beveiligd kan worden met Transport Layer Security (TLS). Merk op dat `start_tls` ingesteld moet zijn op "Uitgeschakeld" voor hosts die het protocol `ldaps://` gebruiken. Mogelijke waarden: 0 - (standaard) Uitgeschakeld; 1 - Ingeschakeld. Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
user_ref_attr	string	LDAP-gebruikersmapattribuut dat wordt gebruikt om naar een gebruikersobject te verwijzen. De waarde van `user_ref_attr` wordt gebruikt om waarden uit het gespecificeerde attribuut in de gebruikersmap te halen en deze in plaats van de %{ref} plaatshouder in de `group_filter`-tekenreeks te plaatsen. Voorbeelden: cn, uid, member, uniqueMember Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type LDAP"
SAML-specifieke eigenschappen:
idp_entityid	string	URI die de identiteitsprovider identificeert en wordt gebruikt om te communiceren met de identiteitsprovider in SAML-berichten. Voorbeeld: https://idp.example.com/idp Gedrag van eigenschap: - vereist als `idp_type` is ingesteld op "Gebruikersmap van het type SAML"
sp_entityid	string	URL of een willekeurige tekenreeks die de serviceprovider van de identiteitsprovider identificeert. Voorbeelden: https://idp.example.com/sp zabbix Gedrag van eigenschap: - vereist als `idp_type` is ingesteld op "Gebruikersmap van het type SAML"
username_attribute	string	SAML-gebruikersmapattribuut (ook SCIM-attribuut als `scim_status` is ingesteld op "SCIM-provisioning is ingeschakeld") dat de gebruikersnaam van de gebruiker bevat, die wordt vergeleken met de waarde van de eigenschap `username` van het Gebruikersobject bij authenticatie. Voorbeelden: 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 Gedrag van eigenschap: - vereist als `idp_type` is ingesteld op "Gebruikersmap van het type SAML"
sso_url	string	URL van de single sign-on-service van de identiteitsprovider voor SAML, waarnaar Zabbix de SAML-authenticatieverzoeken zal sturen. Voorbeeld: http://idp.example.com/idp/sso/saml Gedrag van eigenschap: - vereist als `idp_type` is ingesteld op "Gebruikersmap van het type SAML"
slo_url	string	URL van de single log-out-service van de identiteitsprovider voor SAML, waarnaar Zabbix de SAML-uitlogverzoeken zal sturen. Voorbeeld: https://idp.example.com/idp/slo/saml Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type SAML"
encrypt_nameid	int	Of de SAML-naam-ID versleuteld moet worden. Mogelijke waarden: 0 - (standaard) Naam-ID niet versleutelen; 1 - Naam-ID versleutelen. Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type SAML"
encrypt_assertions	int	Of de SAML-asserties versleuteld moeten worden. Mogelijke waarden: 0 - (standaard) Asserties niet versleutelen; 1 - Asserties versleutelen. Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type SAML"
nameid_format	string	Naam-ID-indeling van de serviceprovider van de SAML-identiteitsprovider. Voorbeelden: 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 Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type SAML"
scim_status	int	Of SCIM-voorziening voor SAML is ingeschakeld of uitgeschakeld. Mogelijke waarden: 0 - (standaard) SCIM-voorziening is uitgeschakeld; 1 - SCIM-voorziening is ingeschakeld. Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type SAML"
sign_assertions	int	Of de SAML-asserties moeten worden ondertekend met een SAML-handtekening. Mogelijke waarden: 0 - (standaard) Asserties niet ondertekenen; 1 - Asserties ondertekenen. Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type SAML"
sign_authn_requests	int	Of de SAML AuthN-verzoeken moeten worden ondertekend met een SAML-handtekening. Mogelijke waarden: 0 - (standaard) AuthN-verzoeken niet ondertekenen; 1 - AuthN-verzoeken ondertekenen. Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type SAML"
sign_messages	int	Of de SAML-berichten moeten worden ondertekend met een SAML-handtekening. Mogelijke waarden: 0 - (standaard) Berichten niet ondertekenen; 1 - Berichten ondertekenen. Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type SAML"
sign_logout_requests	int	Of de SAML-uitlogverzoeken moeten worden ondertekend met een SAML-handtekening. Mogelijke waarden: 0 - (standaard) Uitlogverzoeken niet ondertekenen; 1 - Uitlogverzoeken ondertekenen. Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type SAML"
sign_logout_responses	int	Of de SAML-uitlogreacties moeten worden ondertekend met een SAML-handtekening. Mogelijke waarden: 0 - (standaard) Uitlogreacties niet ondertekenen; 1 - Uitlogreacties ondertekenen. Gedrag van eigenschap: - ondersteund als `idp_type` is ingesteld op "Gebruikersmap van het type SAML"

Media type mappings

Het object 'media type mappings' heeft de volgende eigenschappen.

Eigenschap	Type	Beschrijving
name	string	Zichtbare naam in de lijst van media type mappings. Gedrag van eigenschap: - vereist
mediatypeid	string	ID van het te creëren mediatype; wordt gebruikt als waarde voor de eigenschap `mediatypeid` van het Media-object. Gedrag van eigenschap: - vereist
attribute	string	LDAP/SAML-gebruikersmapattribuut (ook SCIM-attribuut als `scim_status` is ingesteld op "SCIM-provisioning is ingeschakeld") dat de mediagegevens van de gebruiker bevat (bijv. [email protected]), die wordt gebruikt als waarde voor de eigenschap `sendto` van het Media-object. Als dit aanwezig is in de gegevens die ontvangen zijn van de LDAP/SAML-identiteitsprovider en de waarde niet leeg is, dan zal dit mediacreatie activeren voor de geprovisioneerde gebruiker. Gedrag van eigenschap: - vereist

Provisioning groups mappings

De 'provisioning groups mappings' heeft de volgende eigenschappen.

Eigenschap	Type	Beschrijving
name	string	Volledige naam van een groep (bijv. Zabbix-beheerders) in LDAP/SAML-gebruikersmap (ook SCIM als `scim_status` is ingesteld op "SCIM-provisioning is ingeschakeld"). Ondersteunt het wildcard-teken "". Uniek over alle provisioning groups mappings. Gedrag van eigenschap: - vereist*
roleid	string	ID van de gebruikersrol die aan de gebruiker moet worden toegewezen. Als meerdere provisioning groups mappings overeenkomen, wordt de rol van het hoogste gebruikerstype (Gebruiker, Beheerder, of Superbeheerder) aan de gebruiker toegewezen. Als er meerdere rollen zijn met hetzelfde gebruikerstype, wordt de eerste rol (gesorteerd in alfabetische volgorde) aan de gebruiker toegewezen. Gedrag van eigenschap: - vereist
user_groups	array	Array van Zabbix-gebruikersgroep-ID-objecten. Elk object heeft de volgende eigenschappen: `usrgrpid` - `(integer)` ID van Zabbix-gebruikersgroep die aan de gebruiker moet worden toegewezen. Als meerdere provisioning groups mappings overeenkomen, worden Zabbix-gebruikersgroepen van alle overeenkomende mappings aan de gebruiker toegewezen. Gedrag van eigenschap: - vereist

Documentation

> Gebruikersdirectory-object

Gebruikersmap

Media type mappings

Provisioning groups mappings