On this page
Rollen-Objekt
Die folgenden Objekte stehen in direktem Zusammenhang mit der role API.
Rolle
Das Rollenobjekt hat die folgenden Eigenschaften:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| roleid | ID | ID der Rolle. Eigenschaftsverhalten: - schreibgeschützt - erforderlich für Aktualisierungsvorgänge |
| name | string | Name der Rolle. Eigenschaftsverhalten: - erforderlich für Erstellungsvorgänge |
| type | integer | Benutzertyp. Mögliche Werte: 1 - (Standard) Benutzer; 2 - Admin; 3 - Super-Admin. Eigenschaftsverhalten: - erforderlich für Erstellungsvorgänge |
| readonly | integer | Gibt an, ob die Rolle schreibgeschützt ist. Mögliche Werte: 0 - (Standard) Nein; 1 - Ja. Eigenschaftsverhalten: - schreibgeschützt |
Rollenregeln
Das Objekt für Rollenregeln hat die folgenden Eigenschaften:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| ui | array | Array der Objekte vom Typ UI-Element. |
| ui.default_access | integer | Gibt an, ob der Zugriff auf neue UI-Elemente aktiviert ist. Mögliche Werte: 0 - Deaktiviert; 1 - (Standard) Aktiviert. |
| services.read.mode | integer | Schreibgeschützter Zugriff auf Services. Mögliche Werte: 0 - Schreibgeschützter Zugriff auf die Services, die durch die Eigenschaften services.read.list angegeben oder durch services.read.tag abgeglichen werden;1 - (Standard) Schreibgeschützter Zugriff auf alle Services. |
| services.read.list | array | Array von Service-Objekten. Den angegebenen Services, einschließlich untergeordneter Services, wird für die Benutzerrolle schreibgeschützter Zugriff gewährt. Schreibgeschützter Zugriff überschreibt keinen Lese-/Schreibzugriff auf die Services. Verhalten der Eigenschaft: - unterstützt, wenn services.read.mode auf "0" gesetzt ist |
| services.read.tag | object | Array von Service-Tag-Objekten. Den über Tags abgeglichenen Services, einschließlich untergeordneter Services, wird für die Benutzerrolle schreibgeschützter Zugriff gewährt. Schreibgeschützter Zugriff überschreibt keinen Lese-/Schreibzugriff auf die Services. Verhalten der Eigenschaft: - unterstützt, wenn services.read.mode auf "0" gesetzt ist |
| services.write.mode | integer | Lese-/Schreibzugriff auf Services. Mögliche Werte: 0 - (Standard) Lese-/Schreibzugriff auf die Services, die durch die Eigenschaften services.write.list angegeben oder durch services.write.tag abgeglichen werden;1 - Lese-/Schreibzugriff auf alle Services. |
| services.write.list | array | Array von Service-Objekten. Den angegebenen Services, einschließlich untergeordneter Services, wird für die Benutzerrolle Lese-/Schreibzugriff gewährt. Lese-/Schreibzugriff überschreibt schreibgeschützten Zugriff auf die Services. Verhalten der Eigenschaft: - unterstützt, wenn services.write.mode auf "0" gesetzt ist |
| services.write.tag | object | Array von Service-Tag-Objekten. Den über Tags abgeglichenen Services, einschließlich untergeordneter Services, wird für die Benutzerrolle Lese-/Schreibzugriff gewährt. Lese-/Schreibzugriff überschreibt schreibgeschützten Zugriff auf die Services. Verhalten der Eigenschaft: - unterstützt, wenn services.write.mode auf "0" gesetzt ist |
| modules | array | Array der Modul-Objekte. |
| modules.default_access | integer | Gibt an, ob der Zugriff auf neue Module aktiviert ist. Mögliche Werte: 0 - Deaktiviert; 1 - (Standard) Aktiviert. |
| api.access | integer | Gibt an, ob der Zugriff auf die API aktiviert ist. Mögliche Werte: 0 - Deaktiviert; 1 - (Standard) Aktiviert. |
| api.mode | integer | Modus für die Behandlung der in der Eigenschaft api aufgeführten API-Methoden.Mögliche Werte: 0 - (Standard) Sperrliste; 1 - Zulassungsliste. |
| api | array | Array von API-Methoden. |
| actions | array | Array der Aktion-Objekte. |
| actions.default_access | integer | Gibt an, ob der Zugriff auf neue Aktionen aktiviert ist. Mögliche Werte: 0 - Deaktiviert; 1 - (Standard) Aktiviert. |
UI-Element
Das Objekt UI-Element hat die folgenden Eigenschaften:
| Property | Type | Description |
|---|---|---|
| name | string | Name des UI-Elements. Mögliche Werte, wenn type des Objekts Role auf "User", "Admin" oder "Super admin" gesetzt ist:monitoring.dashboard - Dashboards;monitoring.problems - Monitoring > Probleme;monitoring.hosts - Monitoring > Hosts;monitoring.latest_data - Monitoring > Neueste Daten;monitoring.maps - Monitoring > Karten;services.services - Services > Services;services.sla_report - Services > SLA-Bericht;inventory.overview - Inventar > Übersicht;inventory.hosts - Inventar > Hosts;reports.availability_report - Berichte > Verfügbarkeitsbericht;reports.top_triggers - Berichte > Top 100 Auslöser.Mögliche Werte, wenn type des Objekts Role auf "Admin" oder "Super admin" gesetzt ist:monitoring.discovery - Monitoring > Erkennung;services.sla - Services > SLA;reports.scheduled_reports - Berichte > Geplante Berichte;reports.notifications - Berichte > Benachrichtigungen;configuration.template_groups - Datenerfassung > Vorlagengruppen;configuration.host_groups - Datenerfassung > Hostgruppen;configuration.templates - Datenerfassung > Vorlagen;configuration.hosts - Datenerfassung > Hosts;configuration.maintenance - Datenerfassung > Wartung;configuration.discovery - Datenerfassung > Erkennung;configuration.trigger_actions - Warnmeldungen > Aktionen > Auslöser-Aktionen;configuration.service_actions - Warnmeldungen > Aktionen > Service-Aktionen;configuration.discovery_actions - Warnmeldungen > Aktionen > Erkennungsaktionen;configuration.autoregistration_actions - Warnmeldungen > Aktionen > Autoregistrierungsaktionen;configuration.internal_actions - Warnmeldungen > Aktionen > Interne Aktionen.Mögliche Werte, wenn type des Objekts Role auf "Super admin" gesetzt ist:reports.system_info - Berichte > Systeminformationen;reports.audit - Berichte > Audit-Protokoll;reports.action_log - Berichte > Aktionsprotokoll;configuration.event_correlation - Datenerfassung > Ereigniskorrelation;administration.media_types - Warnmeldungen > Medientypen;administration.scripts - Warnmeldungen > Skripte;administration.user_groups - Benutzer > Benutzergruppen;administration.user_roles - Benutzer > Benutzerrollen;administration.users - Benutzer > Benutzer;administration.api_tokens - Benutzer > API-Tokens;administration.authentication - Benutzer > Authentifizierung;administration.general - Administration > Allgemein;administration.audit_log - Administration > Audit-Protokoll;administration.housekeeping - Administration > Housekeeping;administration.proxy_groups - Administration > Proxy-Gruppen;administration.proxies - Administration > Proxies;administration.macros - Administration > Makros;administration.queue - Administration > Warteschlange.Property behavior: - required |
| status | integer | Ob der Zugriff auf das UI-Element aktiviert ist. Mögliche Werte: 0 - Deaktiviert; 1 - (Standard) Aktiviert. |
Service
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| serviceid | ID | ID des Service. Verhalten der Eigenschaft: - erforderlich |
Service-Tag
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| tag | string | Tag-Name. Wenn eine leere Zeichenfolge angegeben wird, wird das Service-Tag nicht für den Service-Abgleich verwendet. Verhalten der Eigenschaft: - erforderlich |
| value | string | Tag-Wert. Wenn kein Wert oder eine leere Zeichenfolge angegeben wird, wird nur der Tag-Name für den Service-Abgleich verwendet. |
Modul
Das Modulobjekt hat die folgenden Eigenschaften:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| moduleid | ID | ID des Moduls. Eigenschaftsverhalten: - erforderlich |
| status | integer | Gibt an, ob der Zugriff auf das Modul aktiviert ist. Mögliche Werte: 0 - Deaktiviert; 1 - (Standard) Aktiviert. |
Aktion
Das Aktionsobjekt hat die folgenden Eigenschaften:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| name | string | Name der Aktion. Mögliche Werte, wenn type des Role-Objekts auf "User", "Admin" oder "Super admin" gesetzt ist:edit_dashboards - Dashboards erstellen und bearbeiten;edit_maps - Karten erstellen und bearbeiten;add_problem_comments - Problemkommentare hinzufügen;change_severity - Problemschweregrad ändern;acknowledge_problems - Probleme bestätigen;suppress_problems - Probleme unterdrücken;close_problems - Probleme schließen;execute_scripts - Skripte ausführen;manage_api_tokens - API-Tokens verwalten;change_problem_ranking - Die Problemrangfolge von Ursache zu Symptom und umgekehrt ändern;edit_own_media - Erstellen/Bearbeiten eigener Medien erlauben.Mögliche Werte, wenn type des Role-Objekts auf "Admin" oder "Super admin" gesetzt ist:edit_maintenance - Wartungen erstellen und bearbeiten;manage_scheduled_reports - Geplante Berichte verwalten,manage_sla - SLA verwalten.Mögliche Werte, wenn type des Role-Objekts auf "User" oder "Admin" gesetzt ist:invoke_execute_now - erlaubt das Ausführen von Datenpunkt-Prüfungen für Benutzer, die nur Leseberechtigungen auf dem Host haben.Mögliche Werte, wenn type des Role-Objekts auf "Super admin" gesetzt ist:edit_user_media - Erstellen/Bearbeiten von Medien für Benutzer erlauben.Eigenschaftsverhalten: - erforderlich |
| status | integer | Ob der Zugriff zum Ausführen der Aktion aktiviert ist. Mögliche Werte: 0 - Deaktiviert; 1 - (Standard) Aktiviert. |