In questa pagina

Oggetto utente

I seguenti oggetti sono direttamente correlati all'API user.

Utente

L'oggetto utente ha le seguenti proprietà.

Property Type Description
userid ID ID dell'utente.

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

Comportamento della proprietà:
- obbligatoria per le operazioni di creazione
- sola lettura per gli utenti sottoposti a provisioning se l'utente è collegato a una directory utenti (userdirectoryid è impostato su un valore valido diverso da "0"), lo stato di provisioning della directory utenti è abilitato (provision_status dell'oggetto User directory è impostato su "1") e lo stato di autenticazione di tutto il 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'utente.

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

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

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

Comportamento della proprietà:
- sola lettura
attempt_failed integer Numero dei tentativi di accesso non riusciti recenti.

Comportamento della proprietà:
- sola lettura
attempt_ip string Indirizzo IP da cui è stato effettuato 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 utente. Accetta un numero di secondi (ad esempio, 1, 60, 300) oppure un valore con un suffisso temporale (ad esempio, 30s, 1m, 2h). Se impostato su 0s, la sessione non scadrà mai.

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

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

Valori possibili:
0 - non sottoposto a provisioning;
1 - sottoposto a provisioning.

Comportamento della proprietà:
- sola lettura
refresh string Periodo di aggiornamento automatico. Accetta un numero di secondi (ad esempio, 1, 60, 300) oppure un valore con un suffisso temporale (ad esempio, 30s, 1m, 1h).

Predefinito: 30s.
rows_per_page integer Numero di righe degli oggetti da visualizzare per pagina.

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

Valori possibili:
default - (predefinito) impostazione predefinita del sistema;
blue-theme - Blu;
blue-classic-theme - Blu (classico);
dark-theme - Scuro;
dark-blue-theme - Blu scuro;
dark-classic-theme - Scuro (classico);
hc-light - Chiaro ad alto contrasto;
hc-dark - Scuro ad alto contrasto.
ts_provisioned timestamp Ora in cui è stata eseguita l'ultima operazione di provisioning.

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

Utilizzato per il provisioning (creazione o aggiornamento) e per consentire l'accesso a un utente collegato a una directory utenti.

Per le operazioni di accesso, il valore di questa proprietà ha la precedenza sulla proprietà userdirectoryid dei gruppi utenti a cui appartiene l'utente.

Predefinito: 0.

Comportamento della proprietà:
- sola lettura
- supportata per gli utenti di tipo Super admin
timezone string Fuso orario dell'utente, ad esempio Europe/London, UTC.

Predefinito: default - impostazione predefinita del sistema.

Per l'elenco completo dei fusi orari supportati, consultare la documentazione PHP.

Media

L'oggetto media presenta le seguenti proprietà.

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

Comportamento della proprietà:
- sola lettura
mediatypeid ID ID del tipo di media utilizzato dal media dell'utente.

Comportamento della proprietà:
- obbligatoria
sendto string/array Indirizzo, nome utente o altro identificatore del destinatario.

Se type di Media type è impostato su "Email" o "Push", i valori sono rappresentati come array. Per "Push", l'array può contenere un carattere jolly (*) oppure uno o più ID di dispositivi mobili.

Se type di Media type è impostato su "Script", "SMS" o "Webhook", il valore è rappresentato come stringa.

Comportamento della proprietà:
- obbligatoria
active integer Indica se il media è abilitato.

Valori possibili:
0 - (predefinito) abilitato;
1 - disabilitato.
severity integer Gravità dei trigger per le quali inviare notifiche.

Valori bitmap possibili:
1 - Non classificato;
2 - Informazioni;
4 - Avviso;
8 - Media;
16 - Alta;
32 - Disastro.

Questo è un campo con maschera di bit; è accettabile qualsiasi somma dei valori bitmap possibili (ad esempio, 48 per Media, Alta e Disastro).

Predefinito: 63.
period string Orario durante il quale è possibile inviare le notifiche, espresso come periodo di tempo o come macro utente separate da un punto e virgola.

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

Valori possibili:
0 - non provisioned;
1 - provisioned.
userdirectory_mediaid ID ID della mappatura del media nella directory utenti per il media provisioned.

Comportamento della proprietà:
- sola lettura
- supportata per gli utenti di tipo Super admin