This is a translation of the original English documentation page. Help us make it better.

Sidebar

> Rolobject

De volgende objecten zijn direct gerelateerd aan de role API.

Rol

Het rolobject heeft de volgende eigenschappen:

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

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

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

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-elementobject heeft de volgende eigenschappen:

Eigenschap Type Beschrijving
name
(verplicht)
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.overzicht - Monitoring → Overzicht;
monitoring .latest_data - Monitoring → Laatste gegevens;
monitoring.maps - Monitoring → Kaarten;
monitoring.services - Monitoring → Services;
inventory.overview - Inventaris → Overzicht;
inventory.hosts - Inventory → Hosts;
reports.availability_report - Rapporten → Beschikbaarheidsrapport;
reports.top_triggers - Rapporten → Triggers top 100.

Alleen mogelijke waarden voor gebruikers van Admin en Super admin gebruikerstypes:
monitoring.discovery - Monitoring → Discovery;
reports.scheduled_reports - Rapporten → Geplande rapporten;
reports.notifications - Rapporten → Meldingen;
configuration.host_groups - Configuratie → Hostgroepen;
configuratie.templates - Configuratie → Sjablonen;
configuration.hosts - Configuratie → Hosts;
configuration.maintenance - Configuratie → Onderhoud;
configuration.actions - Configuratie → Acties;
configuration.discovery - Configuratie → Discovery.

Mogelijke waarden alleen voor gebruikers van Super admin gebruikerstype:
reports.system_info - * Rapporten → Systeeminformatie;
reports.audit -
Rapporten → Audit;
reports.action_log -
Rapporten → Actielogboek;
configuration.event_correlation -
Configuratie → Gebeurtenis correlatie;
administration.general -
Administratie → Algemeen;
administration.proxy's -
Administratie → Proxy's;
administration.authentication -
Administratie → Authenticatie;<br >administration.user_groups - Beheer → Gebruikersgroepen;
administration.user_roles -
Beheer → Gebruikersrollen;
administration.users -
Beheer → Gebruikers;
administratie .media_types -
Administratie → Mediatypen;
administratie.scripts -
Beheer → Scripts;
administratie.wachtrij -
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 actieobject heeft de volgende eigenschappen:

Eigenschap Type Beschrijving
name
(verplicht)
string Naam van de actie.

Mogelijke waarden voor gebruikers van elk type:
edit_dashboards - Dashboards maken en bewerken;
edit_maps - Maak en bewerk kaarten;
add_problem_comments - Voeg probleemopmerkingen toe;
change_severity - Wijzig de ernst van het probleem;
acknowledge_problems - Erken problemen;
close_problems - Sluit problemen;
execute_scripts - Scripts uitvoeren;
manage_api_tokens - API-tokens beheren.

Mogelijke waarden alleen voor gebruikers van de gebruikerstypen Admin en Super admin:
edit_maintenance - Aanmaken en bewerken van onderhoud;
manage_scheduled_reports - Beheer geplande rapporten.
status integer Of de toegang om de actie uit te voeren is ingeschakeld.

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