> Rolobject

De volgende objecten zijn direct gerelateerd aan de role API.

Rol

Het rol-object heeft de volgende eigenschappen:

Eigenschap Type Omschrijving
roleid string (alleen-lezen) ID van de rol.
name
(vereist)
string Naam van de rol.
type
(vereist)
integer Gebruikerstype.

Mogelijke waarden:
1 - (standaard) Gebruiker;
2 - Beheerder;
3 - Superbeheerder.
readonly integer (alleen-lezen) Of de rol alleen-lezen is.

Mogelijke waarden:
0 - (standaard) Nee;
1 - Ja.

Houd er rekening mee dat voor sommige methoden (update, delete) de vereiste/optie-parametercombinatie verschilt.

Rolregels

Het rolregels-object heeft de volgende eigenschappen:

Eigenschap Type Beschrijving
ui array Array van de UI element objecten.
ui.default_access integer Of toegang tot nieuwe UI-elementen is ingeschakeld.

Mogelijke waarden:
0 - Uitgeschakeld;
1 - (standaard) Ingeschakeld.
services.read.mode integer Alleen-lezen toegang tot services.

Mogelijke waarden:

0 - Alleen-lezen toegang tot de services, gespecificeerd door de services.read.list of overeenkomen met de services.read.tag eigenschappen.
1 - (standaard) Alleen-lezen toegang tot alle services.
services.read.list array Array van Service objecten.

De opgegeven services, inclusief onderliggende services, krijgen alleen-lezen toegang tot de gebruikersrol. Alleen-lezen toegang heeft geen voorrang op lees-schrijftoegang tot de services.

Alleen gebruikt als services.read.mode is ingesteld op 0.
services.read.tag object Array van Service tag object.

De met tags overeenkomende services, inclusief onderliggende services, krijgen alleen-lezen toegang tot de gebruikersrol. Alleen-lezen toegang heeft geen voorrang op lees-schrijftoegang tot de services.

Alleen gebruikt als services.read.mode is ingesteld op 0.
services.write.mode integer Lees-schrijftoegang tot services.

Mogelijke waarden:

0 - (standaard) Lees-schrijftoegang tot de services, gespecificeerd door de services. write.list of overeenkomen met de services.write.tag eigenschappen.
1 - Lees-schrijftoegang tot alle services.
services.write.list array Array van Service objecten.

De opgegeven services, inclusief onderliggende services, krijgen lees-schrijftoegang tot de gebruikersrol. Lees-schrijftoegang heeft voorrang op alleen-lezen toegang tot de services.

Alleen gebruikt als services.write.mode is ingesteld op 0.
services.write.tag object Array van Service tag object.

De met tags overeenkomende services, inclusief onderliggende services, krijgen lees-schrijftoegang tot de gebruikersrol. Lees-schrijftoegang heeft voorrang op alleen-lezen toegang tot de services.

Alleen gebruikt als services.write.mode is ingesteld op 0.
modules array Array van de module objecten.
modules.default_access integer Of toegang tot nieuwe modules is ingeschakeld.

Mogelijke waarden:
0 - Uitgeschakeld;
1 - (standaard) Ingeschakeld.
api.access integer Of toegang tot API is ingeschakeld.

Mogelijke waarden:
0 - Uitgeschakeld;
1 - (standaard) Ingeschakeld.
api.mode integer Modus voor het behandelen van API-methoden die worden vermeld in de eigenschap api.

Mogelijke waarden:
0 - (standaard) Lijst weigeren;
1 - Lijst toestaan.
api array Array van API-methoden.
actions array Array van de action objecten.
actions.default_access integer Of toegang tot nieuwe acties is ingeschakeld.

Mogelijke waarden:
0 - Uitgeschakeld;
1 - (standaard) Ingeschakeld.

UI-element

Het UI-element object heeft de volgende eigenschappen:

Eigenschap Type Omschrijving
name
(vereist)
string Naam van het UI-element.

Mogelijke waarden voor gebruikers van elk type:
monitoring.dashboard - Monitoring → Dashboard;
monitoring.problems - Monitoring → Problemen;
monitoring.hosts - Monitoring → Hosts;
monitoring.latest_data - Monitoring → Laatste gegevens;
monitoring.maps - Monitoring → Kaarten;
services.services - Services → Services;
services.sla_report - Services → SLA-rapport;
inventory.overview - Voorraad → Overzicht;
inventory.hosts - Voorraad → Hosts;
reports.availability_report - Rapporten → Beschikbaarheidsrapport;
reports.top_triggers - Rapporten → Top 100 triggers.

Mogelijke waarden alleen voor gebruikers van de gebruikerstypen Beheerder en Superbeheerder:
monitoring.discovery - Monitoring → Ontdekking;
services.actions - Services → Service-acties;
services.sla - Services → SLA;
reports.scheduled_reports - Rapporten → Geplande rapporten;
reports.notifications - Rapporten → Meldingen;
configuration.host_groups - Configuratie → Hostgroepen;
configuration.templates - Configuratie → Sjablonen;
configuration.hosts - Configuratie → Hosts;
configuration.maintenance - Configuratie → Onderhoud;
configuration.actions - Configuratie → Acties;
configuration.discovery - Configuratie → Ontdekking.

Mogelijke waarden alleen voor gebruikers van het gebruikerstype Superbeheerder:
reports.system_info - Rapporten → Systeeminformatie;
reports.audit - Rapporten → Controle;
reports.action_log - Rapporten → Actie-logboek;
configuration.event_correlation - Configuratie → Gebeurteniscorrelatie;
administration.general - Beheer → Algemeen;
administration.proxies - Beheer → Proxies;
administration.authentication - Beheer → Authenticatie;
administration.user_groups - Beheer → Gebruikersgroepen;
administration.user_roles - Beheer → Gebruikersrollen;
administration.users - Beheer → Gebruikers;
administration.media_types - Beheer → Mediatypen;
administration.scripts - Beheer → Scripts;
administration.queue - Beheer → Wachtrij.
status integer Of toegang tot het UI-element is ingeschakeld.

Mogelijke waarden:
0 - Uitgeschakeld;
1 - (standaard) Ingeschakeld.

Onderhoud

Eigenschap Type Beschrijving
serviceid
(vereist)
string ID van de service.

Servicetag

Eigenschap Type Beschrijving
tag
(verplicht)
string Tagnaam.

Als een lege tekenreeks is opgegeven, wordt de servicetag niet gebruikt voor serviceovereenkomsten.
value string Tagwaarde.

Als er geen waarde of lege tekenreeks is opgegeven, wordt alleen de tagnaam gebruikt voor serviceovereenkomsten.

Module

Het moduleobject heeft de volgende eigenschappen:

Eigenschap Type Beschrijving
moduleid
(verplicht)
string ID van de module.
status integer Of toegang tot de module is ingeschakeld.

Mogelijke waarden:
0 - Uitgeschakeld;
1 - (standaard) Ingeschakeld.

Actie

Het actie-object heeft de volgende eigenschappen:

Eigenschap Type Omschrijving
name
(vereist)
string Naam van de actie.

Mogelijke waarden voor gebruikers van elk type:
edit_dashboards - Dashboards maken en bewerken;
edit_maps - Kaarten maken en bewerken;
add_problem_comments - Opmerkingen bij problemen toevoegen;
change_severity - Probleemernst wijzigen;
acknowledge_problems - Problemen erkennen;
close_problems - Problemen sluiten;
execute_scripts - Scripts uitvoeren;
manage_api_tokens - API-tokens beheren.

Mogelijke waarden alleen voor gebruikers van het gebruikerstype Beheerder en Superbeheerder:
edit_maintenance - Onderhoud maken en bewerken;
manage_scheduled_reports - Geplande rapporten beheren;
manage_sla - SLA beheren.
status integer Of toegang tot het uitvoeren van de actie is ingeschakeld.

Mogelijke waarden:
0 - Uitgeschakeld;
1 - (standaard) Ingeschakeld.