Oggetto directory utente

I seguenti oggetti sono direttamente correlati all'API userdirectory.

Directory utenti

L'oggetto directory utenti presenta le seguenti proprietà.

Proprietà Tipo Descrizione
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.

Comportamento della proprietà:
- sola lettura
- obbligatoria per le operazioni di aggiornamento
idp_type integer Tipo di protocollo di autenticazione utilizzato dall'identity provider per la directory utenti.
È possibile avere una sola directory utenti di tipo SAML.

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

Comportamento della proprietà:
- obbligatoria per le operazioni di creazione
group_name string Attributo della directory utenti LDAP/SAML che contiene il nome del gruppo utilizzato per mappare i gruppi tra la directory utenti LDAP/SAML e Zabbix.

Esempio: cn

Comportamento della proprietà:
- obbligatoria 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, utilizzato come valore della proprietà name dell'oggetto User quando l'utente viene sottoposto a provisioning.

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, utilizzato come valore della proprietà surname dell'oggetto User quando l'utente viene sottoposto a provisioning.

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

Valori possibili:
0 - (predefinito) Disabled (il provisioning degli utenti creati da questa directory utenti è disabilitato);
1 - Enabled (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 modello del gruppo utenti LDAP/SAML al gruppo utenti e al ruolo utente Zabbix.

Comportamento della proprietà:
- obbligatoria 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, l'e-mail) ai media utente Zabbix per l'invio delle notifiche.
Proprietà specifiche di LDAP:
name string Nome univoco della directory utenti.

Comportamento della proprietà:
- obbligatoria se idp_type è impostato su "User directory of type LDAP"
host string Nome host, IP o URI del server LDAP.
L'URI deve contenere lo schema (ldap:// o ldaps://), l'host e, facoltativamente, la porta.

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

Comportamento della proprietà:
- obbligatoria se idp_type è impostato su "User directory of type LDAP"
port integer Porta del server LDAP.

Comportamento della proprietà:
- obbligatoria se idp_type è impostato su "User directory of type LDAP"
base_dn string Percorso di base della directory utenti LDAP agli 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)

Comportamento della proprietà:
- obbligatoria se idp_type è impostato su "User directory of type LDAP"
search_attribute string Attributo della directory utenti LDAP utilizzato per identificare l'account utente in base alle informazioni fornite nella richiesta di accesso.

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

Comportamento della proprietà:
- obbligatoria se idp_type è impostato su "User directory of type LDAP"
bind_dn string Account del server LDAP utilizzato 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

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type LDAP"
bind_password string Password LDAP dell'account utilizzato per il binding e la ricerca nel server LDAP.

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

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type LDAP"
description string Descrizione della directory utenti.

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type LDAP"
group_basedn string Percorso di base della directory utenti LDAP ai gruppi; utilizzato per configurare un controllo dell'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

Comportamento della proprietà:
- supportata 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; utilizzata per configurare un controllo dell'appartenenza dell'utente nella directory utenti LDAP.

Ignorata 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 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.

Comportamento della proprietà:
- supportata 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; utilizzato per configurare un controllo dell'appartenenza dell'utente nella directory utenti LDAP.

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

Comportamento della proprietà:
- supportata 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

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type LDAP"
search_filter string Stringa di filtro personalizzata utilizzata 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 Zabbix.

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

Comportamento della proprietà:
- supportata 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 utilizzando Transport Layer Security (TLS).

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

Valori possibili:
0 - (predefinito) Disabled;
1 - Enabled.

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type LDAP"
user_ref_attr string Attributo della directory utenti LDAP utilizzato per fare riferimento a un oggetto utente. Il valore di user_ref_attr viene utilizzato 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

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type LDAP"
Proprietà specifiche di SAML:
idp_entityid string URI che identifica l'identity provider e viene utilizzato per comunicare con l'identity provider nei messaggi SAML.

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

Comportamento della proprietà:
- obbligatoria se idp_type è impostato su "User directory of type SAML"
sp_entityid string URL o stringa che identifica il service provider dell'identity provider.

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

Comportamento della proprietà:
- obbligatoria 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 dell'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

Comportamento della proprietà:
- obbligatoria se idp_type è impostato su "User directory of type SAML"
sso_url string URL del servizio SAML single sign-on dell'identity provider, a cui Zabbix invierà le richieste di autenticazione SAML.

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

Comportamento della proprietà:
- obbligatoria se idp_type è impostato su "User directory of type SAML"
slo_url string URL del servizio SAML single log-out dell'identity provider, a cui Zabbix invierà le richieste di disconnessione SAML.

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

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type SAML"
encrypt_nameid integer Indica se il name ID SAML deve essere crittografato.

Valori possibili:
0 - (predefinito) Non crittografare il name ID;
1 - Crittografare il name ID.

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type SAML"
encrypt_assertions integer Indica se le asserzioni SAML devono essere crittografate.

Valori possibili:
0 - (predefinito) Non crittografare le asserzioni;
1 - Crittografare le asserzioni.

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type SAML"
nameid_format string Formato del name ID del service provider dell'identity provider 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

Comportamento della proprietà:
- supportata 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 - (predefinito) SCIM provisioning is disabled;
1 - SCIM provisioning is enabled.

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type SAML"
sign_assertions integer Indica se le asserzioni SAML devono essere firmate con una firma SAML.

Valori possibili:
0 - (predefinito) Non firmare le asserzioni;
1 - Firmare le asserzioni.

Comportamento della proprietà:
- supportata 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 - (predefinito) Non firmare le richieste AuthN;
1 - Firmare le richieste AuthN.

Comportamento della proprietà:
- supportata 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 - (predefinito) Non firmare i messaggi;
1 - Firmare i messaggi.

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type SAML"
sign_logout_requests integer Indica se le richieste di disconnessione SAML devono essere firmate con una firma SAML.

Valori possibili:
0 - (predefinito) Non firmare le richieste di disconnessione;
1 - Firmare le richieste di disconnessione.

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type SAML"
sign_logout_responses integer Indica se le risposte di disconnessione SAML devono essere firmate con una firma SAML.

Valori possibili:
0 - (predefinito) Non firmare le risposte di disconnessione;
1 - Firmare le risposte di disconnessione.

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type SAML"
idp_certificate string Contenuto del certificato del Service Provider (SP) per la configurazione del servizio SAML single sign-on (SSO).

Esempi:
-----BEGIN CERTIFICATE-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7...
...more encoded data...
-----END CERTIFICATE-----

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type SAML" e $SSO['CERT_STORAGE'] è impostato su database nel file di configurazione del frontend
- sola scrittura
sp_private_key string Contenuto della chiave privata del Service Provider (SP) per la configurazione del servizio SAML single sign-on (SSO).
Fornisce autenticazione sicura e scambio di dati con l'Identity Provider (IdP).

Esempi:
-----BEGIN CERTIFICATE-----
MIIEvQIBADANBgkqhkiG9w0BA...
...more encoded data...
-----END CERTIFICATE-----

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type SAML" e $SSO['CERT_STORAGE'] è impostato su database nel file di configurazione del frontend
- sola scrittura
sp_certificate string Contenuto del certificato del Service Provider (SP) per la configurazione del servizio SAML single sign-on (SSO).

Esempi:
-----BEGIN CERTIFICATE-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7...
...more encoded data...
-----END CERTIFICATE-----

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type SAML" e $SSO['CERT_STORAGE'] è impostato su database nel file di configurazione del frontend
- sola scrittura
idp_certificate_hash string Hash md5 del valore di idp_certificate. Restituisce una stringa vuota per un idp_certificate vuoto.

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type SAML" e $SSO['CERT_STORAGE'] è impostato su database nel file di configurazione del frontend
- sola lettura
sp_private_key_hash string Hash md5 del valore di sp_private_key. Restituisce una stringa vuota per uno sp_private_key vuoto.

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type SAML" e $SSO['CERT_STORAGE'] è impostato su database nel file di configurazione del frontend
- sola lettura
sp_certificate_hash string Hash md5 del valore di sp_certificate. Restituisce una stringa vuota per uno sp_certificate vuoto.

Comportamento della proprietà:
- supportata se idp_type è impostato su "User directory of type SAML" e $SSO['CERT_STORAGE'] è impostato su database nel file di configurazione del frontend
- sola lettura

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