[comment]: # aside: 1
[comment]: # ({c9088bab-f9e8f670})
# Oggetto directory utente
I seguenti oggetti sono direttamente correlati all'API `userdirectory`.
[comment]: # ({/c9088bab-f9e8f670})
[comment]: # ({726c81ec-ad144502})
### Directory utenti
L'oggetto directory utenti ha le seguenti proprietà.
|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|userdirectoryid|ID|ID della directory utenti.
Se una directory utenti viene eliminata, il valore della proprietà `userdirectoryid` dell'[oggetto User](/manual/api/reference/user/object#user) viene impostato su "0" per tutti gli utenti collegati alla directory utenti eliminata.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *sola lettura*
- *obbligatoria* per le operazioni di aggiornamento|
|idp_type|integer|Tipo di protocollo di autenticazione utilizzato dal provider di identità per la directory utenti.
Si noti che può esistere una sola directory utenti di tipo SAML.
Valori possibili:
1 - Directory utenti di tipo LDAP;
2 - Directory utenti di tipo SAML.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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à](/manual/api/reference_commentary#property-behavior):
- *obbligatoria* se `provision_status` è impostato su "Enabled" e `saml_jit_status` dell'[oggetto Authentication](/manual/api/reference/authentication/object#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 per la proprietà `name` dell'[oggetto User](/manual/api/reference/user/object#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, utilizzato come valore per la proprietà `surname` dell'[oggetto User](/manual/api/reference/user/object#user) quando l'utente viene provisionato.
Esempi: *sn*, *surname*, *lastName*|
|provision_status|integer|Stato del provisioning della directory utenti.
Valori possibili:
0 - *(predefinito)* Disabilitato (il provisioning degli utenti creati da questa directory utenti è disabilitato);
1 - Abilitato (il provisioning degli utenti creati da questa directory utenti è abilitato; inoltre, deve essere abilitato lo stato del provisioning LDAP o SAML (`ldap_jit_status` o `saml_jit_status` dell'[oggetto Authentication](/manual/api/reference/authentication/object#authentication))).|
|provision_groups|array|Array di oggetti [mappature dei gruppi di provisioning](object#provisioning-groups-mappings) per mappare il pattern del gruppo utenti LDAP/SAML al gruppo utenti e al ruolo utente di Zabbix.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *obbligatoria* se `provision_status` è impostato su "Enabled"|
|provision_media|array|Array di oggetti [mappature dei tipi di supporto](object#media-type-mappings) per mappare gli attributi media LDAP/SAML dell'utente (ad esempio, email) ai media utente di Zabbix per l'invio di notifiche.|
|**Proprietà specifiche di [LDAP](/manual/web_interface/frontend_sections/users/authentication/ldap):**|<|<|
|name|string|Nome univoco della directory utenti.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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 schema (`ldap://` o `ldaps://`), host e porta (opzionale).
Esempi:
*host.example.com*
*127.0.0.1*
*ldap://ldap.example.com:389*
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *obbligatoria* se `idp_type` è impostato su "User directory of type LDAP"|
|port|integer|Porta del server LDAP.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *obbligatoria* se `idp_type` è impostato su "User directory of type LDAP"|
|base_dn|string|Percorso di base della directory utenti LDAP verso 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)
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *obbligatoria* se `idp_type` è impostato su "User directory of type LDAP"|
|search_attribute|string|Attributo della directory utenti LDAP tramite il quale identificare l'account utente a partire dalle informazioni fornite nella richiesta di login.
Esempi:
*uid* (per OpenLDAP)
*sAMAccountName* (per Microsoft Active Directory)
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *obbligatoria* 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*
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *supportata* 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.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *supportata* se `idp_type` è impostato su "User directory of type LDAP"|
|description|string|Descrizione della directory utenti.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *supportata* se `idp_type` è impostato su "User directory of type LDAP"|
|group_basedn|string|Percorso di base della directory utenti LDAP verso i gruppi; utilizzato 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*
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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 di appartenenza dell'utente nella directory utenti LDAP.
Ignorata durante il provisioning di un utente se `group_membership` è impostato.
Segnaposto supportati per `group_filter`:
*%{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}* - username 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.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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 di appartenenza dell'utente nella directory utenti LDAP.
Ignorato durante il provisioning di un utente se `group_membership` è impostato.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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à](/manual/api/reference_commentary#property-behavior):
- *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 login.
Segnaposto supportati per `search_filter`:
*%{attr}* - nome dell'attributo di ricerca (ad esempio, *uid*, *sAMAccountName*);
*%{user}* - username dell'utente Zabbix.
Predefinito: *(%{attr}=%{user})*
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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).
Si noti che `start_tls` deve essere impostato su "Disabled" per gli host che utilizzano il protocollo `ldaps://`.
Valori possibili:
0 - *(predefinito)* Disabilitato;
1 - Abilitato.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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 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à](/manual/api/reference_commentary#property-behavior):
- *supportata* se `idp_type` è impostato su "User directory of type LDAP"|
|**Proprietà specifiche di [SAML](/manual/web_interface/frontend_sections/users/authentication/saml):**|<|<|
|idp_entityid|string|URI che identifica il provider di identità e viene utilizzato per comunicare con il provider di identità nei messaggi SAML.
Esempio: *https://idp.example.com/idp*
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *obbligatoria* 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*
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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 lo username dell'utente, confrontato con il valore della proprietà `username` dell'[oggetto User](/manual/api/reference/user/object#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à](/manual/api/reference_commentary#property-behavior):
- *obbligatoria* se `idp_type` è impostato su "User directory of type SAML"|
|sso_url|string|URL del servizio SAML single sign-on del provider di identità, a cui Zabbix invierà le richieste di autenticazione SAML.
Esempio: *http://idp.example.com/idp/sso/saml*
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *obbligatoria* se `idp_type` è impostato su "User directory of type SAML"|
|slo_url|string|URL del servizio SAML single log-out del provider di identità, a cui Zabbix invierà le richieste di logout SAML.
Esempio: *https://idp.example.com/idp/slo/saml*
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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 - Crittografa il name ID.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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 - Crittografa le asserzioni.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *supportata* se `idp_type` è impostato su "User directory of type SAML"|
|nameid_format|string|Formato del 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*
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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)* Il provisioning SCIM è disabilitato;
1 - Il provisioning SCIM è abilitato.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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 - Firma le asserzioni.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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 - Firma le richieste AuthN.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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 - Firma i messaggi.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *supportata* 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 - *(predefinito)* Non firmare le richieste di logout;
1 - Firma le richieste di logout.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *supportata* 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 - *(predefinito)* Non firmare le risposte di logout;
1 - Firma le risposte di logout.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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à](/manual/api/reference_commentary#property-behavior):
- *supportata* se `idp_type` è impostato su "User directory of type SAML" e `$SSO['CERT_STORAGE']` è impostato su `database` in zabbix.conf.php
- *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à](/manual/api/reference_commentary#property-behavior):
- *supportata* se `idp_type` è impostato su "User directory of type SAML" e `$SSO['CERT_STORAGE']` è impostato su `database` in zabbix.conf.php
- *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à](/manual/api/reference_commentary#property-behavior):
- *supportata* se `idp_type` è impostato su "User directory of type SAML" e `$SSO['CERT_STORAGE']` è impostato su `database` in zabbix.conf.php
- *sola scrittura*|
|idp_certificate_hash|string|Hash md5 del valore di idp_certificate. Restituisce una stringa vuota se idp_certificate è vuoto.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *supportata* se `idp_type` è impostato su "User directory of type SAML" e `$SSO['CERT_STORAGE']` è impostato su `database` in zabbix.conf.php
- *sola lettura*|
|sp_private_key_hash|string|Hash md5 del valore di sp_private_key. Restituisce una stringa vuota se sp_private_key è vuoto.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *supportata* se `idp_type` è impostato su "User directory of type SAML" e `$SSO['CERT_STORAGE']` è impostato su `database` in zabbix.conf.php
- *sola lettura*|
|sp_certificate_hash|string|Hash md5 del valore di sp_certificate. Restituisce una stringa vuota se sp_certificate è vuoto.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *supportata* se `idp_type` è impostato su "User directory of type SAML" e `$SSO['CERT_STORAGE']` è impostato su `database` in zabbix.conf.php
- *sola lettura*|
[comment]: # ({/726c81ec-ad144502})
[comment]: # ({07d3d820-c2b51996})
#### Mappature dei tipi di supporto
L'oggetto delle mappature dei tipi di supporto ha le seguenti proprietà.
|Proprietà|[Tipo](/manual/api/reference_commentary#data-types)|Descrizione|
|--|--|----------------|
|userdirectory_mediaid|ID|ID della mappatura del tipo di supporto.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *sola lettura*|
|name|string|Nome visibile nell'elenco delle mappature dei tipi di supporto.
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *obbligatoria*|
|mediatypeid|ID|ID del tipo di supporto da creare; utilizzato come valore per la proprietà `mediatypeid` dell'[oggetto Media](/manual/api/reference/user/object#media).
[Comportamento della proprietà](/manual/api/reference_commentary#property-behavior):
- *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, *user@example.com*), utilizzato come valore per la proprietà `sendto` dell'[oggetto Media](/manual/api/reference/user/object#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à](/manual/api/reference_commentary#property-behavior):
- *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.|
[comment]: # ({/07d3d820-c2b51996})
[comment]: # ({fe544518-67bd0ce1})
#### Mappature dei gruppi di provisioning
Le mappature dei gruppi di provisioning hanno le seguenti proprietà.
|Proprietà|[Tipo](/manual/api/reference_commentary#data-types)|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à](/manual/api/reference_commentary#property-behavior):
- *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à](/manual/api/reference_commentary#property-behavior):
- *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à](/manual/api/reference_commentary#property-behavior):
- *required*|
[comment]: # ({/fe544518-67bd0ce1})