Oggetto directory utente

I seguenti oggetti sono direttamente correlati all'API userdirectory.

Directory utenti

L'oggetto directory utenti ha le seguenti proprietà.

Property Type Description
userdirectoryid ID ID della directory utenti.

Se una directory utenti viene eliminata, il valore della proprietà userdirectoryid dell'oggetto User viene impostato su "0" per tutti gli utenti collegati alla directory utenti eliminata.

Property behavior:
- read-only
- required per le operazioni di aggiornamento
idp_type integer Tipo del protocollo di autenticazione utilizzato dal provider di identità per la directory utenti.
Nota che può esistere una sola directory utenti di tipo SAML.

Valori possibili:
1 - Directory utenti di tipo LDAP;
2 - Directory utenti di tipo SAML.

Property behavior:
- required per le operazioni di creazione
group_name string Attributo della directory utenti LDAP/SAML che contiene il nome del gruppo usato per mappare i gruppi tra la directory utenti LDAP/SAML e Zabbix.

Esempio: cn

Property behavior:
- required se provision_status è impostato su "Enabled" e saml_jit_status dell'oggetto Authentication è impostato su "Enabled for configured SAML IdPs"
user_username string Attributo della directory utenti LDAP/SAML (anche attributo SCIM se scim_status è impostato su "SCIM provisioning is enabled") che contiene il nome dell'utente, usato come valore della proprietà name dell'oggetto User quando l'utente viene provisionato.

Esempi: cn, commonName, displayName, name
user_lastname string Attributo della directory utenti LDAP/SAML (anche attributo SCIM se scim_status è impostato su "SCIM provisioning is enabled") che contiene il cognome dell'utente, usato come valore della proprietà surname dell'oggetto User quando l'utente viene provisionato.

Esempi: sn, surname, lastName
provision_status integer Stato del provisioning della directory utenti.

Valori possibili:
0 - (default) Disabilitato (il provisioning degli utenti creati da questa directory utenti è disabilitato);
1 - Abilitato (il provisioning degli utenti creati da questa directory utenti è abilitato; inoltre, lo stato del provisioning LDAP o SAML (ldap_jit_status o saml_jit_status dell'oggetto Authentication) deve essere abilitato).
provision_groups array Array di oggetti mappature dei gruppi di provisioning per mappare il pattern del gruppo utente LDAP/SAML al gruppo utenti e al ruolo utente di Zabbix.

Property behavior:
- required se provision_status è impostato su "Enabled"
provision_media array Array di oggetti mappature dei tipi di media per mappare gli attributi media LDAP/SAML dell'utente (ad esempio, email) ai media utente di Zabbix per l'invio delle notifiche.
LDAP-specific properties:
name string Nome univoco della directory utenti.

Property behavior:
- required se idp_type è impostato su "User directory of type LDAP"
host string Nome host, IP o URI del server LDAP.
L'URI deve contenere schema (ldap:// o ldaps://), host e porta (opzionale).

Esempi:
host.example.com
127.0.0.1
ldap://ldap.example.com:389

Property behavior:
- required se idp_type è impostato su "User directory of type LDAP"
port integer Porta del server LDAP.

Property behavior:
- required se idp_type è impostato su "User directory of type LDAP"
base_dn string Percorso base della directory utenti LDAP per gli account utente.

Esempi:
ou=Users,dc=example,dc=org
ou=Users,ou=system (per OpenLDAP)
DC=company,DC=com (per Microsoft Active Directory)
uid=%{user},dc=example,dc=com (per il binding diretto dell'utente; il segnaposto "%{user}" è obbligatorio)

Property behavior:
- required se idp_type è impostato su "User directory of type LDAP"
search_attribute string Attributo della directory utenti LDAP con cui identificare l'account utente dalle informazioni fornite nella richiesta di accesso.

Esempi:
uid (per OpenLDAP)
sAMAccountName (per Microsoft Active Directory)

Property behavior:
- required se idp_type è impostato su "User directory of type LDAP"
bind_dn string Account del server LDAP per il binding e la ricerca nel server LDAP.

Per il binding diretto dell'utente e il binding anonimo, bind_dn deve essere vuoto.

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

Property behavior:
- supported se idp_type è impostato su "User directory of type LDAP"
bind_password string Password LDAP dell'account per il binding e la ricerca nel server LDAP.

Per il binding diretto dell'utente e il binding anonimo, bind_password deve essere vuoto.

Property behavior:
- supported se idp_type è impostato su "User directory of type LDAP"
description string Descrizione della directory utenti.

Property behavior:
- supported se idp_type è impostato su "User directory of type LDAP"
group_basedn string Percorso base della directory utenti LDAP per i gruppi; usato per configurare un controllo di appartenenza dell'utente nella directory utenti LDAP.

Ignorato durante il provisioning di un utente se group_membership è impostato.

Esempio: ou=Groups,dc=example,dc=com

Property behavior:
- supported se idp_type è impostato su "User directory of type LDAP"
group_filter string Stringa di filtro per recuperare i gruppi della directory utenti LDAP di cui l'utente è membro; usata per configurare un controllo di appartenenza dell'utente nella directory utenti LDAP.

Ignorato durante il provisioning di un utente se group_membership è impostato.

Segnaposto group_filter supportati:
%{attr} - attributo di ricerca (sostituito dal valore della proprietà search_attribute);
%{groupattr} - attributo del gruppo (sostituito dal valore della proprietà group_member);
%{host} - nome host, IP o URI del server LDAP (sostituito dal valore della proprietà host);
%{user} - nome utente dell'utente Zabbix.

Predefinito: (%{groupattr}=%{user})

Esempi:
- (member=uid=%{ref},ou=Users,dc=example,dc=com) corrisponderà a "User1" se un oggetto gruppo LDAP contiene l'attributo "member" con il valore "uid=User1,ou=Users,dc=example,dc=com", e restituirà il gruppo di cui "User1" è membro;
- (%{groupattr}=cn=%{ref},ou=Users,ou=Zabbix,DC=example,DC=com) corrisponderà a "User1" se un oggetto gruppo LDAP contiene l'attributo specificato nella proprietà group_member con il valore "cn=User1,ou=Users,ou=Zabbix,DC=example,DC=com", e restituirà il gruppo di cui "User1" è membro.

Property behavior:
- supported se idp_type è impostato su "User directory of type LDAP"
group_member string Attributo della directory utenti LDAP che contiene informazioni sui membri del gruppo; usato per configurare un controllo di appartenenza dell'utente nella directory utenti LDAP.

Ignorato durante il provisioning di un utente se group_membership è impostato.

Property behavior:
- supported se idp_type è impostato su "User directory of type LDAP"
group_membership string Attributo della directory utenti LDAP che contiene informazioni sui gruppi a cui appartiene un utente.

Esempio: memberOf

Property behavior:
- supported se idp_type è impostato su "User directory of type LDAP"
search_filter string Stringa di filtro personalizzata usata per individuare e autenticare un utente in una directory utenti LDAP in base alle informazioni fornite nella richiesta di accesso.

Segnaposto search_filter supportati:
%{attr} - nome dell'attributo di ricerca (ad esempio, uid, sAMAccountName);
%{user} - nome utente dell'utente Zabbix.

Predefinito: (%{attr}=%{user})

Property behavior:
- supported se idp_type è impostato su "User directory of type LDAP"
start_tls integer Opzione di configurazione del server LDAP che consente di proteggere la comunicazione con il server LDAP usando Transport Layer Security (TLS).

Nota che start_tls deve essere impostato su "Disabled" per gli host che usano il protocollo ldaps://.

Valori possibili:
0 - (default) Disabilitato;
1 - Abilitato.

Property behavior:
- supported se idp_type è impostato su "User directory of type LDAP"
user_ref_attr string Attributo della directory utenti LDAP usato per fare riferimento a un oggetto utente. Il valore di user_ref_attr viene usato per ottenere i valori dall'attributo specificato nella directory utenti e inserirli al posto del segnaposto %{ref} nella stringa group_filter.

Esempi: cn, uid, member, uniqueMember

Property behavior:
- supported se idp_type è impostato su "User directory of type LDAP"
SAML-specific properties:
idp_entityid string URI che identifica il provider di identità e viene usato per comunicare con il provider di identità nei messaggi SAML.

Esempio: https://idp.example.com/idp

Property behavior:
- required se idp_type è impostato su "User directory of type SAML"
sp_entityid string URL o qualsiasi stringa che identifica il service provider del provider di identità.

Esempi:
https://idp.example.com/sp
zabbix

Property behavior:
- required se idp_type è impostato su "User directory of type SAML"
username_attribute string Attributo della directory utenti SAML (anche attributo SCIM se scim_status è impostato su "SCIM provisioning is enabled") che contiene il nome utente, confrontato con il valore della proprietà username dell'oggetto User durante l'autenticazione.

Esempi: 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

Property behavior:
- required se idp_type è impostato su "User directory of type SAML"
sso_url string URL del servizio SAML single sign-on del provider di identità, al quale Zabbix invierà le richieste di autenticazione SAML.

Esempio: http://idp.example.com/idp/sso/saml

Property behavior:
- required se idp_type è impostato su "User directory of type SAML"
slo_url string URL del servizio SAML single log-out del provider di identità, al quale Zabbix invierà le richieste di logout SAML.

Esempio: https://idp.example.com/idp/slo/saml

Property behavior:
- supported se idp_type è impostato su "User directory of type SAML"
encrypt_nameid integer Indica se il Name ID SAML deve essere cifrato.

Valori possibili:
0 - (default) Non cifrare il Name ID;
1 - Cifra il Name ID.

Property behavior:
- supported se idp_type è impostato su "User directory of type SAML"
encrypt_assertions integer Indica se le assertion SAML devono essere cifrate.

Valori possibili:
0 - (default) Non cifrare le assertion;
1 - Cifra le assertion.

Property behavior:
- supported se idp_type è impostato su "User directory of type SAML"
nameid_format string Formato Name ID del service provider del provider di identità SAML.

Esempi:
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

Property behavior:
- supported se idp_type è impostato su "User directory of type SAML"
scim_status integer Indica se il provisioning SCIM per SAML è abilitato o disabilitato.

Valori possibili:
0 - (default) Provisioning SCIM disabilitato;
1 - Provisioning SCIM abilitato.

Property behavior:
- supported se idp_type è impostato su "User directory of type SAML"
sign_assertions integer Indica se le assertion SAML devono essere firmate con una firma SAML.

Valori possibili:
0 - (default) Non firmare le assertion;
1 - Firma le assertion.

Property behavior:
- supported se idp_type è impostato su "User directory of type SAML"
sign_authn_requests integer Indica se le richieste AuthN SAML devono essere firmate con una firma SAML.

Valori possibili:
0 - (default) Non firmare le richieste AuthN;
1 - Firma le richieste AuthN.

Property behavior:
- supported se idp_type è impostato su "User directory of type SAML"
sign_messages integer Indica se i messaggi SAML devono essere firmati con una firma SAML.

Valori possibili:
0 - (default) Non firmare i messaggi;
1 - Firma i messaggi.

Property behavior:
- supported se idp_type è impostato su "User directory of type SAML"
sign_logout_requests integer Indica se le richieste di logout SAML devono essere firmate con una firma SAML.

Valori possibili:
0 - (default) Non firmare le richieste di logout;
1 - Firma le richieste di logout.

Property behavior:
- supported se idp_type è impostato su "User directory of type SAML"
sign_logout_responses integer Indica se le risposte di logout SAML devono essere firmate con una firma SAML.

Valori possibili:
0 - (default) Non firmare le risposte di logout;
1 - Firma le risposte di logout.

Property behavior:
- supported se idp_type è impostato su "User directory of type SAML"

Mappature dei tipi di supporto

L'oggetto delle mappature dei tipi di supporto ha le seguenti proprietà.

Proprietà Tipo Descrizione
userdirectory_mediaid ID ID della mappatura del tipo di supporto.

Comportamento della proprietà:
- sola lettura
name string Nome visibile nell'elenco delle mappature dei tipi di supporto.

Comportamento della proprietà:
- obbligatoria
mediatypeid ID ID del tipo di supporto da creare; utilizzato come valore per la proprietà mediatypeid dell'oggetto Media.

Comportamento della proprietà:
- obbligatoria
attribute string Attributo della directory utenti LDAP/SAML (anche attributo SCIM se scim_status è impostato su "SCIM provisioning is enabled") che contiene il supporto dell'utente (ad esempio, [email protected]), utilizzato come valore per la proprietà sendto dell'oggetto Media.

Se presente nei dati ricevuti dal provider di identità LDAP/SAML e il valore non è vuoto, questo attiverà la creazione del supporto per l'utente sottoposto a provisioning.

Comportamento della proprietà:
- obbligatoria
active integer Valore della proprietà active del supporto utente quando il supporto viene creato per l'utente sottoposto a provisioning.

Valori possibili:
0 - (predefinito) abilitato;
1 - disabilitato.
severity integer Valore della proprietà severity del supporto utente quando il supporto viene creato per l'utente sottoposto a provisioning.

Predefinito: 63.
period string Valore della proprietà period del supporto utente quando il supporto viene creato per l'utente sottoposto a provisioning.

Predefinito: 1-7,00:00-24:00.

Mappature dei gruppi di provisioning

Le mappature dei gruppi di provisioning hanno le seguenti proprietà.

Proprietà Tipo Descrizione
name string Nome completo di un gruppo (ad esempio, Zabbix administrators) nella directory utenti LDAP/SAML (anche SCIM se scim_status è impostato su "SCIM provisioning is enabled").
Supporta il carattere jolly "*".
Univoco tra tutte le mappature dei gruppi di provisioning.

Comportamento della proprietà:
- required
roleid ID ID del ruolo utente da assegnare all'utente.

Se corrispondono più mappature dei gruppi di provisioning, all'utente viene assegnato il ruolo con il tipo di utente più alto (User, Admin o Super admin). Se sono presenti più ruoli con lo stesso tipo di utente, all'utente viene assegnato il primo ruolo (ordinato in ordine alfabetico).

Comportamento della proprietà:
- required
user_groups array Array di oggetti ID dei gruppi utenti di Zabbix. Ogni oggetto ha le seguenti proprietà:
usrgrpid - (ID) ID del gruppo utenti di Zabbix da assegnare all'utente.

Se corrispondono più mappature dei gruppi di provisioning, all'utente vengono assegnati i gruppi utenti di Zabbix di tutte le mappature corrispondenti.

Comportamento della proprietà:
- required