On this page

Oggetto utente

I seguenti oggetti sono direttamente correlati all'API user.

User

L'oggetto user ha le seguenti proprietà.

Property Type Description
userid ID ID dell'user.

Comportamento della proprietà:
- sola lettura
- obbligatoria per le operazioni di aggiornamento
username string Nome dell'user.

Comportamento della proprietà:
- obbligatoria per le operazioni di creazione
- sola lettura per gli user provisioned se l'user è collegato a una user directory (userdirectoryid è impostato a un valore valido diverso da "0"), e lo stato di provisioning della user directory è abilitato (provision_status dell'oggetto User directory è impostato su "1"), e lo stato di autenticazione di tutti i provisioning LDAP o SAML è abilitato (ldap_jit_status dell'oggetto Authentication è impostato su "Enabled for configured LDAP IdPs" oppure saml_jit_status dell'oggetto Authentication è impostato su "Enabled for configured SAML IdPs")
passwd string Password dell'user.

Il valore di questo parametro può essere una stringa vuota se l'user è collegato a una user directory.

Comportamento della proprietà:
- sola scrittura
roleid ID ID del ruolo dell'user.

Si noti che gli user senza un ruolo possono accedere a Zabbix solo tramite autenticazione LDAP o SAML, a condizione che le loro informazioni LDAP/SAML corrispondano alle mappature dei gruppi di user configurate in Zabbix.
attempt_clock timestamp Ora dell'ultimo tentativo di accesso non riuscito.

Comportamento della proprietà:
- sola lettura
attempt_failed integer Numero recente di tentativi di accesso falliti.

Comportamento della proprietà:
- sola lettura
attempt_ip string Indirizzo IP da cui è provenuto l'ultimo tentativo di accesso non riuscito.

Comportamento della proprietà:
- sola lettura
autologin integer Indica se abilitare l'accesso automatico.

Valori possibili:
0 - (predefinito) accesso automatico disabilitato;
1 - accesso automatico abilitato.
autologout string Durata della sessione dell'user. Accetta secondi e unità di tempo con suffisso. Se impostato su 0s, la sessione non scadrà mai.

Predefinito: 15m.
lang string Codice della lingua dell'user, ad esempio en_US.

Predefinito: default - impostazione predefinita del sistema.
name string Nome dell'user.
provisioned integer Indica se l'user è stato provisioned.

Valori possibili:
0 - non provisioned;
1 - provisioned.

Questa proprietà è supportata da Zabbix 7.0.9.

Comportamento della proprietà:
- sola lettura
refresh string Intervallo di aggiornamento automatico. Accetta secondi o unità di tempo con suffisso (ad esempio, 30s, 90s, 1m, 1h).

Predefinito: 30s.
rows_per_page integer Numero di righe dell'oggetto da mostrare per pagina.

Predefinito: 50.
surname string Cognome dell'user.
theme string Tema dell'user.

Valori possibili:
default - (predefinito) impostazione predefinita del sistema;
blue-theme - Blue;
dark-theme - Dark;
hc-light - High-contrast light;
hc-dark - High-contrast dark.
ts_provisioned timestamp Ora in cui è stata eseguita l'ultima operazione di provisioning.

Comportamento della proprietà:
- sola lettura
- supportata per gli user di tipo Super admin (da Zabbix 7.0.9)
url string URL della pagina a cui reindirizzare l'user dopo l'accesso.
userdirectoryid ID ID della user directory a cui è collegato l'user.

Usato per il provisioning (creazione o aggiornamento), così come per autenticare un user collegato a una user directory.

Per le operazioni di accesso, il valore di questa proprietà avrà priorità rispetto alla proprietà userdirectoryid dei user groups a cui l'user appartiene.

Predefinito: 0.

Comportamento della proprietà:
- sola lettura
- supportata per gli user di tipo Super admin (da Zabbix 7.0.9)
timezone string Fuso orario dell'user, ad esempio Europe/London, UTC.

Predefinito: default - impostazione predefinita del sistema.

Per l'elenco completo dei fusi orari supportati, fare riferimento alla documentazione PHP.

Media

L'oggetto media ha le seguenti proprietà.

Property Type Description
mediaid ID ID del media dell'utente.

Property behavior:
- read-only
mediatypeid ID ID del tipo di media utilizzato dal media dell'utente.

Property behavior:
- required
sendto string/array Indirizzo, nome utente o altro identificatore del destinatario.

Se type di Media type è impostato su "Email", i valori sono rappresentati come array. Per gli altri tipi di Media types, il valore è rappresentato come stringa.

Property behavior:
- required
active integer Indica se il media è abilitato.

Valori possibili:
0 - (default) abilitato;
1 - disabilitato.
severity integer Trigger severity per cui inviare notifiche.

Valori bitmap possibili:
1 - Not classified;
2 - Information;
4 - Warning;
8 - Average;
16 - High;
32 - Disaster.

Questo è un campo bitmask; è accettabile qualsiasi somma dei valori bitmap possibili (ad esempio, 48 per Average, High e Disaster).

Default: 63.
period string Orario in cui le notifiche possono essere inviate come time period o macro utente separate da un punto e virgola.

Default: 1-7,00:00-24:00.
provisioned integer Indica se l'utente è stato provisioned.

Valori possibili:
0 - non provisioned;
1 - provisioned.

Questa proprietà è supportata da Zabbix 7.0.9.
userdirectory_mediaid ID ID di mapping del media della directory utente per i media provisioned.

Property behavior:
- read-only
- supported per utenti di tipo Super admin (da Zabbix 7.0.9)