Documentation
Table of Contents
> Rolobject
De volgende objecten zijn direct gerelateerd aan de role API.
Rol
Het rolobject heeft de volgende eigenschappen:
| Eigenschap | Type | Beschrijving |
|---|---|---|
| roleid | string | ID van de rol. Eigenschapsgedrag: - alleen-lezen - vereist voor update-operaties |
| name | string | Naam van de rol. Eigenschapsgedrag: - vereist voor maakoperaties |
| type | integer | Gebruikerstype. Mogelijke waarden: 1 - (standaard) Gebruiker; 2 - Beheerder; 3 - Superbeheerder. Eigenschapsgedrag: - vereist voor maakoperaties |
| readonly | integer | Of de rol alleen-lezen is. Mogelijke waarden: 0 - (standaard) Nee; 1 - Ja. Eigenschapsgedrag: - alleen-lezen |
Rolregels
Het object met rolregels heeft de volgende eigenschappen:
| Eigenschap | Type | Beschrijving |
|---|---|---|
| ui | array | Array van 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 gematcht door de services.read.tag eigenschappen;1 - (standaard) Alleen-lezen toegang tot alle services. |
| services.read.list | array | Array van Service objecten. De gespecificeerde services, inclusief kindservices, krijgen alleen-lezen toegang tot de gebruikersrol. Alleen-lezen toegang overschrijft geen lees-schrijf-toegang tot de services. Eigenschapsgedrag: - ondersteund als services.read.mode is ingesteld op "0" |
| services.read.tag | object | Array van Service tag objecten. De gematchte services met tags, inclusief kindservices, krijgen alleen-lezen toegang tot de gebruikersrol. Alleen-lezen toegang overschrijft geen lees-schrijf-toegang tot de services. Eigenschapsgedrag: - ondersteund als services.read.mode is ingesteld op "0" |
| services.write.mode | integer | Lees-schrijf-toegang tot services. Mogelijke waarden: 0 - (standaard) Lees-schrijf-toegang tot de services, gespecificeerd door de services.write.list of gematcht door de services.write.tag eigenschappen;1 - Lees-schrijf-toegang tot alle services. |
| services.write.list | array | Array van Service objecten. De gespecificeerde services, inclusief kindservices, krijgen lees-schrijf-toegang tot de gebruikersrol. Lees-schrijf-toegang overschrijft alleen-lezen toegang tot de services. Eigenschapsgedrag: - ondersteund als services.write.mode is ingesteld op "0" |
| services.write.tag | object | Array van Service tag objecten. De gematchte services met tags, inclusief kindservices, krijgen lees-schrijf-toegang tot de gebruikersrol. Lees-schrijf-toegang overschrijft alleen-lezen toegang tot de services. Eigenschapsgedrag: - ondersteund als services.write.mode is ingesteld op "0" |
| modules | array | Array van 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 behandeling van API-methoden vermeld in de api eigenschap.Mogelijke waarden: 0 - (standaard) Weigeringslijst; 1 - Toegangslijst. |
| api | array | Array van API-methoden. |
| actions | array | Array van 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 | string | Naam van het UI-element. Mogelijke waarden als type van het Rol object is ingesteld op "Gebruiker", "Beheerder" of "Super beheerder":monitoring.dashboard - Dashboards;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 - Inventaris ¡ú Overzicht;inventory.hosts - Inventaris ¡ú Hosts;reports.availability_report - Rapporten ¡ú Beschikbaarheidsrapport;reports.top_triggers - Rapporten ¡ú Top 100 triggers.Mogelijke waarden als type van het Rol object is ingesteld op "Beheerder" of "Super beheerder":monitoring.discovery - Monitoring ¡ú Ontdekking;services.sla - Services ¡ú SLA;reports.scheduled_reports - Rapporten ¡ú Geplande rapporten;reports.notifications - Rapporten ¡ú Meldingen;configuration.template_groups - Gegevensverzameling ¡ú Sjabloon groepen;configuration.host_groups - Gegevensverzameling ¡ú Host groepen;configuration.templates - Gegevensverzameling ¡ú Sjablonen;configuration.hosts - Gegevensverzameling ¡ú Hosts;configuration.maintenance - Gegevensverzameling ¡ú Onderhoud;configuration.discovery - Gegevensverzameling ¡ú Ontdekking;configuration.trigger_actions - Meldingen ¡ú Acties ¡ú Triggeracties;configuration.service_actions - Meldingen ¡ú Acties ¡ú Serviceacties;configuration.discovery_actions - Meldingen ¡ú Acties ¡ú Ontdekkingsacties;configuration.autoregistration_actions - Meldingen ¡ú Acties ¡ú Automatische registratieacties;configuration.internal_actions - Meldingen ¡ú Acties ¡ú Interne acties.Mogelijke waarden als type van het Rol object is ingesteld op "Super beheerder":reports.system_info - Rapporten ¡ú Systeeminformatie;reports.audit - Rapporten ¡ú Auditlogboek;reports.action_log - Rapporten ¡ú Actielogboek;configuration.event_correlation - Gegevensverzameling ¡ú Gebeurteniscorrelatie;administration.media_types - Meldingen ¡ú Mediatypes;administration.scripts - Meldingen ¡ú Scripts;administration.user_groups - Gebruikers ¡ú Gebruikersgroepen;administration.user_roles - Gebruikers ¡ú Gebruikersrollen;administration.users - Gebruikers ¡ú Gebruikers;administration.api_tokens - Gebruikers ¡ú API-tokens;administration.authentication - Gebruikers ¡ú Authenticatie;administration.general - Beheer ¡ú Algemeen;administration.audit_log - Beheer ¡ú Auditlogboek;administration.housekeeping - Beheer ¡ú Schoonmaak;administration.proxies - Beheer ¡ú Proxies;administration.macros - Beheer ¡ú Macro's;administration.queue - Beheer ¡ú Wachtrij.Eigenschapsgedrag: - vereist |
| status | integer | Of toegang tot het UI-element is ingeschakeld. Mogelijke waarden: 0 - Uitgeschakeld; 1 - (standaard) Ingeschakeld. |
Service
| Eigenschap | Type | Beschrijving |
|---|---|---|
| serviceid | string | ID van de service. Eigenschapsgedrag: - vereist |
Service tag
| Eigenschap | Type | Beschrijving |
|---|---|---|
| tag | string | Naam van de tag. Als een lege string wordt opgegeven, wordt de servicetag niet gebruikt voor servicematching. Eigenschapsgedrag: - vereist |
| value | string | Tagwaarde. Als er geen waarde of een lege string wordt opgegeven, wordt alleen de tagnaam gebruikt voor servicematching. |
Module
Het module-object heeft de volgende eigenschappen:
| Eigenschap | Type | Beschrijving |
|---|---|---|
| moduleid | string | ID van de module. Eigenschapsgedrag: - vereist |
| 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 | Beschrijving |
|---|---|---|
| name | string | Naam van de actie. Mogelijke waarden als type van Role-object is ingesteld op "Gebruiker", "Beheerder" of "Superbeheerder: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;suppress_problems - Problemen onderdrukken;close_problems - Problemen sluiten;execute_scripts - Scripts uitvoeren;manage_api_tokens - API-tokens beheren.Mogelijke waarden als type van Role-object is ingesteld op "Beheerder" of "Superbeheerder":edit_maintenance - Onderhoud maken en bewerken;manage_scheduled_reports - Geplande rapporten beheren;manage_sla - SLA beheren.Mogelijke waarden als type van Role-object is ingesteld op "Gebruiker" of "Beheerder":invoke_execute_now - Hiermee kunnen itemcontroles worden uitgevoerd voor gebruikers met alleen leesrechten op de host.Eigenschapsgedrag: - vereist |
| status | integer | Of toegang tot het uitvoeren van de actie is ingeschakeld. Mogelijke waarden: 0 - Uitgeschakeld; 1 - (standaard) Ingeschakeld. |