Oggetto ruolo

I seguenti oggetti sono direttamente correlati all'API role.

Ruolo

L'oggetto ruolo ha le seguenti proprietà:

Proprietà Tipo Descrizione
roleid ID ID del ruolo.

Comportamento della proprietà:
- sola lettura
- obbligatoria per le operazioni di aggiornamento
name string Nome del ruolo.

Comportamento della proprietà:
- obbligatoria per le operazioni di creazione
type integer Tipo di utente.

Valori possibili:
1 - (predefinito) Utente;
2 - Admin;
3 - Super admin.

Comportamento della proprietà:
- obbligatoria per le operazioni di creazione
readonly integer Indica se il ruolo è di sola lettura.

Valori possibili:
0 - (predefinito) No;
1 - Sì.

Comportamento della proprietà:
- sola lettura

Regole dei ruoli

L'oggetto delle regole del ruolo presenta le seguenti proprietà:

Proprietà Tipo Descrizione
ui array Array di oggetti elemento dell'interfaccia utente.
ui.default_access integer Indica se l'accesso ai nuovi elementi dell'interfaccia utente è abilitato.

Valori possibili:
0 - Disabilitato;
1 - (predefinito) Abilitato.
profile.redirect.enforce integer Indica se l'URL di reindirizzamento a livello di ruolo dopo l'autenticazione è obbligatorio e non può essere sovrascritto dall'utente.

Valori possibili:
0 - (predefinito) Disabilitato;
1 - Abilitato.
profile.redirect.url string URL utilizzato per il reindirizzamento dell'utente dopo l'autenticazione.
services.read.mode integer Accesso in sola lettura ai servizi.

Valori possibili:
0 - Accesso in sola lettura ai servizi specificati dalle proprietà services.read.list o corrispondenti alla proprietà services.read.tag;
1 - (predefinito) Accesso in sola lettura a tutti i servizi.
services.read.list array Array di oggetti Service.

Ai servizi specificati, inclusi i servizi figlio, verrà concesso l'accesso in sola lettura al ruolo utente. L'accesso in sola lettura non sovrascriverà l'accesso in lettura-scrittura ai servizi.

Comportamento della proprietà:
- supportata se services.read.mode è impostato su "0".
services.read.tag object Array di oggetti Service tag.

Ai servizi corrispondenti ai tag, inclusi i servizi figlio, verrà concesso l'accesso in sola lettura al ruolo utente. L'accesso in sola lettura non sovrascriverà l'accesso in lettura-scrittura ai servizi.

Comportamento della proprietà:
- supportata se services.read.mode è impostato su "0".
services.write.mode integer Accesso in lettura-scrittura ai servizi.

Valori possibili:
0 - (predefinito) Accesso in lettura-scrittura ai servizi specificati dalle proprietà services.write.list o corrispondenti alla proprietà services.write.tag;
1 - Accesso in lettura-scrittura a tutti i servizi.
services.write.list array Array di oggetti Service.

Ai servizi specificati, inclusi i servizi figlio, verrà concesso l'accesso in lettura-scrittura al ruolo utente. L'accesso in lettura-scrittura sovrascriverà l'accesso in sola lettura ai servizi.

Comportamento della proprietà:
- supportata se services.write.mode è impostato su "0".
services.write.tag object Array di oggetti Service tag.

Ai servizi corrispondenti ai tag, inclusi i servizi figlio, verrà concesso l'accesso in lettura-scrittura al ruolo utente. L'accesso in lettura-scrittura sovrascriverà l'accesso in sola lettura ai servizi.

Comportamento della proprietà:
- supportata se services.write.mode è impostato su "0".
modules array Array di oggetti module.
modules.default_access integer Indica se l'accesso ai nuovi moduli è abilitato.

Valori possibili:
0 - Disabilitato;
1 - (predefinito) Abilitato.
api.access integer Indica se l'accesso all'API è abilitato.

Valori possibili:
0 - (predefinito) Disabilitato;
1 - Abilitato.
api.mode integer Modalità per la gestione dei metodi API elencati nella proprietà api.

Valori possibili:
0 - (predefinito) Elenco di negazione;
1 - Elenco di autorizzazione.

Comportamento della proprietà:
- supportata se api.access è impostato su "1".
api array Array di metodi API.

I caratteri jolly sono supportati, ad esempio: * (qualsiasi metodo), dashboard.*, *.export.

Se non viene specificato alcun metodo, l'accesso a tutti i metodi API viene negato se api.mode è impostato su "1" (Elenco di autorizzazione) e consentito se api.mode è impostato su "0" (Elenco di negazione).

Comportamento della proprietà:
- supportata se api.access è impostato su "1".
actions array Array di oggetti action.
actions.default_access integer Indica se l'accesso alle nuove azioni è abilitato.

Valori possibili:
0 - Disabilitato;
1 - (predefinito) Abilitato.
devices.access integer Indica se l'accesso ai dispositivi mobili dell'utente per l'utilizzo con Zabbix mobile app è abilitato.

Valori possibili:
0 - (predefinito per User e Admin) Disabilitato;
1 - (predefinito per Super admin) Abilitato.

Comportamento della proprietà:
- supportata se EnableMobileDevices è abilitato
devices.actions array Array di oggetti Device action.

Comportamento della proprietà:
- supportata se devices.access è impostato su "1"
devices.actions.default_access integer Indica se l'accesso alle nuove azioni dei dispositivi è abilitato.

Valori possibili:
0 - (predefinito per User e Admin) Disabilitato;
1 - (predefinito per Super admin) Abilitato.

Comportamento della proprietà:
- supportata se EnableMobileDevices è abilitato

Elemento dell'interfaccia utente

L'oggetto elemento dell'interfaccia utente ha le seguenti proprietà:

Proprietà Tipo Descrizione
name string Nome dell'elemento dell'interfaccia utente.

Valori possibili se type dell'oggetto Role è impostato su "User", "Admin" o "Super admin":
monitoring.dashboard - Dashboard;
monitoring.problems - Monitoring > Problems;
monitoring.hosts - Monitoring > Hosts;
monitoring.latest_data - Monitoring > Latest data;
monitoring.maps - Monitoring > Maps;
services.services - Services > Services;
services.sla_report - Services > SLA report;
inventory.overview - Inventory > Overview;
inventory.hosts - Inventory > Hosts;
reports.availability_report - Reports > Availability report;
reports.top_triggers - Reports > Triggers top 100.

Valori possibili se type dell'oggetto Role è impostato su "Admin" o "Super admin":
monitoring.discovery - Monitoring > Discovery;
services.sla - Services > SLA;
reports.scheduled_reports - Reports > Scheduled reports;
reports.notifications - Reports > Notifications;
configuration.template_groups - Data collection > Template groups;
configuration.host_groups - Data collection > Host groups;
configuration.templates - Data collection > Templates;
configuration.hosts - Data collection > Hosts;
configuration.maintenance - Data collection > Maintenance;
configuration.event_processing - Data collection > Event processing;
configuration.discovery - Data collection > Discovery;
configuration.trigger_actions - Alerts > Actions > Trigger actions;
configuration.service_actions - Alerts > Actions > Service actions;
configuration.discovery_actions - Alerts > Actions > Discovery actions;
configuration.autoregistration_actions - Alerts > Actions > Autoregistration actions;
configuration.internal_actions - Alerts > Actions > Internal actions.

Valori possibili se type dell'oggetto Role è impostato su "Super admin":
reports.system_info - Reports > System information;
reports.audit - Reports > Audit log;
reports.action_log - Reports > Action log;
administration.media_types - Alerts > Media types;
administration.scripts - Alerts > Scripts;
administration.user_groups - Users > User groups;
administration.user_roles - Users > User roles;
administration.users - Users > Users;
administration.api_tokens - Users > API tokens;
administration.authentication - Users > Authentication;
administration.general - Administration > General;
administration.audit_log - Administration > Audit log;
administration.housekeeping - Administration > Housekeeping;
administration.proxy_groups - Administration > Proxy groups;
administration.proxies - Administration > Proxies;
administration.macros - Administration > Macros;
administration.queue - Administration > Queue.

Comportamento della proprietà:
- obbligatoria
name string Nome dell'elemento dell'interfaccia utente.

Valori possibili se type dell'oggetto Role è impostato su "User", "Admin" o "Super admin":
monitoring.dashboard - Dashboard;
monitoring.problems - Monitoring > Problems;
monitoring.hosts - Monitoring > Hosts;
monitoring.latest_data - Monitoring > Latest data;
monitoring.maps - Monitoring > Maps;
services.services - Services > Services;
services.sla_report - Services > SLA report;
inventory.overview - Inventory > Overview;
inventory.hosts - Inventory > Hosts;
reports.availability_report - Reports > Availability report;
reports.top_triggers - Reports > Triggers top 100.

Valori possibili se type dell'oggetto Role è impostato su "Admin" o "Super admin":
monitoring.discovery - Monitoring > Discovery;
services.sla - Services > SLA;
reports.scheduled_reports - Reports > Scheduled reports;
reports.notifications - Reports > Notifications;
configuration.template_groups - Data collection > Template groups;
configuration.host_groups - Data collection > Host groups;
configuration.templates - Data collection > Templates;
configuration.hosts - Data collection > Hosts;
configuration.maintenance - Data collection > Maintenance;
configuration.discovery - Data collection > Discovery;
configuration.trigger_actions - Alerts > Actions > Trigger actions;
configuration.service_actions - Alerts > Actions > Service actions;
configuration.discovery_actions - Alerts > Actions > Discovery actions;
configuration.autoregistration_actions - Alerts > Actions > Autoregistration actions;
configuration.internal_actions - Alerts > Actions > Internal actions.

Valori possibili se type dell'oggetto Role è impostato su "Super admin":
reports.system_info - Reports > System information;
reports.audit - Reports > Audit log;
reports.action_log - Reports > Action log;
configuration.event_correlation - Data collection > Event correlation;
administration.media_types - Alerts > Media types;
administration.scripts - Alerts > Scripts;
administration.user_groups - Users > User groups;
administration.user_roles - Users > User roles;
administration.users - Users > Users;
administration.api_tokens - Users > API tokens;
administration.authentication - Users > Authentication;
administration.linked_devices - Users > Devices;
administration.general - Administration > General;
administration.audit_log - Administration > Audit log;
administration.housekeeping - Administration > Housekeeping;
administration.proxy_groups - Administration > Proxy groups;
administration.proxies - Administration > Proxies;
administration.macros - Administration > Macros;
administration.queue - Administration > Queue.

Comportamento della proprietà:
- obbligatoria
status integer Indica se l'accesso all'elemento dell'interfaccia utente è abilitato.

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

Servizio

Proprietà Type Descrizione
serviceid ID ID del servizio.

Comportamento della proprietà:
- obbligatorio

Tag del servizio

Property Type Description
tag string Nome del tag.

Se viene specificata una stringa vuota, il tag del servizio non verrà utilizzato per la corrispondenza del servizio.

Comportamento della proprietà:
- obbligatorio
value string Valore del tag.

Se non viene specificato alcun valore o viene specificata una stringa vuota, per la corrispondenza del servizio verrà utilizzato solo il nome del tag.

Modulo

L'oggetto modulo ha le seguenti proprietà:

Proprietà Tipo Descrizione
moduleid ID ID del modulo.

Comportamento della proprietà:
- obbligatorio
status integer Indica se l'accesso al modulo è abilitato.

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

Azione

L'oggetto action presenta le seguenti proprietà:

Property Type Description
name string Nome dell'action.

Valori possibili se type dell'oggetto Role è impostato su "User", "Admin" o "Super admin":
edit_dashboards - Creare e modificare dashboard;
edit_maps - Creare e modificare mappe;
add_problem_comments - Aggiungere commenti ai problemi;
change_severity - Modificare la gravità dei problemi;
acknowledge_problems - Confermare i problemi;
suppress_problems - Sopprimere i problemi;
close_problems - Chiudere i problemi;
execute_scripts - Eseguire script;
manage_api_tokens - Gestire i token API;
change_problem_ranking - Modificare la classificazione del problema da causa a sintomo e viceversa;
edit_own_media - Consentire agli utenti di creare e modificare i propri media.

Valori possibili se type dell'oggetto Role è impostato su "Admin" o "Super admin":
edit_maintenance - Creare e modificare le attività di manutenzione;
manage_scheduled_reports - Gestire i report pianificati,
manage_sla - Gestire gli SLA,
select_server_for_monitoring - Consentire agli utenti di creare host monitorati dal server e dalle regole di network discovery eseguite dal server.

Valori possibili se type dell'oggetto Role è impostato su "User" o "Admin":
invoke_execute_now - Consentire agli utenti con sole autorizzazioni di lettura su un host di eseguire i controlli degli item.

Valori possibili se type dell'oggetto Role è impostato su "Super admin":
edit_user_media - Consentire agli utenti di creare e modificare i media per altri utenti.

Comportamento della proprietà:
- required
status integer Indica se l'accesso per eseguire l'azione è abilitato.

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

Azione del dispositivo

L'oggetto azione del dispositivo presenta le seguenti proprietà:

Property Type Description
name string Nome dell'azione del dispositivo.

Valori possibili se type dell'oggetto Role è impostato su "User", "Admin" o "Super admin":
manage_own - Consente agli utenti di aggiungere o rimuovere i propri dispositivi mobili.

Valori possibili se type dell'oggetto Role è impostato su "Super admin":
manage_user - Consente agli utenti di aggiungere o rimuovere dispositivi mobili per tutti gli utenti.

Comportamento della proprietà:
- required
status integer Indica se l'accesso per eseguire l'azione è abilitato.

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