Poniższe obiekty są bezpośrednio powiązane z interfejsem API role.
Obiekt role ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| roleid | string | (tylko do odczytu) ID roli. |
| name (wymagane) |
string | Nazwa roli. |
| type (wymagane) |
integer | Typ użytkownika. Możliwe wartości: 1 - (domyślnie) Użytkownik; 2 - Administrator; 3 - Super administrator. |
| readonly | integer | (tylko do odczytu) Czy rola jest tylko do odczytu. Możliwe wartości: 0 - (domyślnie) Nie; 1 - Tak. |
Zauważ, że dla niektórych metod (update, delete) kombinacja wymaganych/opcjonalnych parametrów jest różna.
Obiekt role rules ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| ui | array | Tablica obiektów elementu UI. |
| ui.default_access | integer | Czy dostęp do nowych elementów interfejsu użytkownika jest włączony. Możliwe wartości: 0 - Wyłączony; 1 - (domyślnie) Włączony. |
| services.read.mode | integer | Dostęp tylko do odczytu do usług. Możliwe wartości: 0 - Dostęp tylko do odczytu do usług określonych przez właściwości services.read.list lub dopasowanych przez właściwość services.read.tag.1 - (domyślnie) Dostęp tylko do odczytu do wszystkich usług. |
| services.read.list | array | Tablica obiektów usługi. Określone usługi, włącznie z usługami potomnymi, zostaną udzielone dostępu tylko do odczytu do roli użytkownika. Dostęp tylko do odczytu nie zastąpi dostępu do odczytu i zapisu do usług. Używane tylko wtedy, gdy services.read.mode jest ustawione na 0. |
| services.read.tag | object | Tablica obiektów znacznika usługi. Usługi dopasowane do znacznika, włącznie z usługami potomnymi, gdzie zostanie udzielony dostęp tylko do odczytu do roli użytkownika. Dostęp tylko do odczytu nie zastąpi dostępu do odczytu i zapisu do usług. Używane tylko wtedy, gdy services.read.mode jest ustawione na 0. |
| services.write.mode | integer | Dostęp do zapisu do usług. Możliwe wartości: 0 - (domyślnie) Dostęp do zapisu do usług określonych przez właściwości services.write.list lub dopasowanych przez właściwość services.write.tag.1 - Dostęp do zapisu do wszystkich usług. |
| services.write.list | array | Tablica obiektów usługi. Określone usługi, włącznie z usługami potomnymi, zostaną udzielone dostępu do zapisu do roli użytkownika. Dostęp do zapisu zastąpi dostęp tylko do odczytu do usług. Używane tylko wtedy, gdy services.write.mode jest ustawione na 0. |
| services.write.tag | object | Tablica obiektów znacznika usługi. Usługi dopasowane do znacznika, włącznie z usługami potomnymi, gdzie zostanie udzielony dostęp do zapisu do roli użytkownika. Dostęp do zapisu zastąpi dostęp tylko do odczytu do usług. Używane tylko wtedy, gdy services.write.mode jest ustawione na 0. |
| modules | array | Tablica obiektów moduł. |
| modules.default_access | integer | Czy dostęp do nowych modułów jest włączony. Możliwe wartości: 0 - Wyłączony; 1 - (domyślnie) Włączony. |
| api.access | integer | Czy dostęp do interfejsu API jest włączony. Możliwe wartości: 0 - Wyłączony; 1 - (domyślnie) Włączony. |
| api.mode | integer | Tryb traktowania metod interfejsu API wymienionych w właściwości api.Możliwe wartości: 0 - (domyślnie) Lista zabroniona; 1 - Lista zezwoleń. |
| api | array | Tablica metod API. |
| actions | array | Tablica obiektów akcji. |
| actions.default_access | integer | Czy dostęp do nowych akcji jest włączony. Możliwe wartości: 0 - Wyłączony; 1 - (domyślnie) Włączony. |
Obiekt UI element ma następujące właściwości:
|Właściwość|Typ|Opis| |name
(wymagane)|string|Nazwa elementu interfejsu użytkownika.
Możliwe wartości dla użytkowników dowolnego typu:monitoring.dashboard - Monitoring → Pulpit;monitoring.problems - Monitoring → Problemy;monitoring.hosts - Monitoring → Hosty;monitoring.latest_data - Monitoring → Ostatnie dane;monitoring.maps - Monitoring → Mapy;services.services - Usługi → Usługi;services.sla_report - Usługi → Raport SLA;inventory.overview - Inwentarz → Przegląd;inventory.hosts - Inwentarz → Hosty;reports.availability_report - Raporty → Raport dostępności;reports.top_triggers - Raporty → TOP 100 wyzwalaczy.
Możliwe wartości tylko dla użytkowników typu Admin i Super admin:monitoring.discovery - Monitoring → Wykrywanie;services.actions - Usługi → Akcje usługi;services.sla - Usługi → SLA;reports.scheduled_reports - Raporty → Raporty okresowe;reports.notifications - Raporty → Powiadomienia;configuration.host_groups - Konfiguracja → Grupy hostów;configuration.templates - Konfiguracja → Szablony;configuration.hosts - Konfiguracja → Hosty;configuration.maintenance - Konfiguracja → Utrzymanie;configuration.actions - Konfiguracja → Akcje;configuration.discovery - Konfiguracja → Wykrywanie.
Możliwe wartości tylko dla użytkowników typu Super admin:reports.system_info - Raporty → Informacje o systemie;reports.audit - Raporty → Log audytu;reports.action_log - Raporty → Log akcji;configuration.event_correlation - Konfiguracja → Korelacja zdarzeń;administration.general - Administracja → Ogólne;administration.proxies - Administracja → Proxy;administration.authentication - Administracja → Uwierzytelnianie;administration.user_groups - Administracja → Grupy użytkowników;administration.user_roles - Administracja → Role użytkowników;administration.users - Administracja → Użytkownicy;administration.media_types - Administracja → Typy mediów;administration.scripts - Administracja → Skrypty;administration.queue - Administracja → Kolejka.| |status|integer|Czy dostęp do elementu interfejsu użytkownika jest włączony.
Możliwe wartości:
0 - Wyłączony;
1 - (domyślnie) Włączony.|
| Właściwość | Typ | Opis |
|---|---|---|
| serviceid (wymagane) |
string | ID usługi. |
| Właściwość | Typ | Opis |
|---|---|---|
| tag (wymagane) |
string | Nazwa znacznika. Jeśli podano pusty ciąg znaków, tag usługi nie będzie używany do dopasowywania usługi. |
| value | string | Wartość tagu. Jeśli nie podano wartości lub jest to pusty ciąg znaków, do dopasowania usługi zostanie użyta tylko nazwa znacznika. |
Obiekt module ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| moduleid (wymagane) |
string | ID modułu. |
| status | integer | Czy dostęp do modułu jest włączony. Możliwe wartości: 0 - Wyłączone; 1 - (domyślne) Włączone. |
Obiekt action ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| name (wymagane) |
string | Nazwa akcji. Możliwe wartości dla użytkowników dowolnego typu: edit_dashboards - Tworzenie i edycja pulpitów;edit_maps - Tworzenie i edycja map;add_problem_comments - Dodawanie komentarzy do problemów;change_severity - Zmiana poziomu problemu;acknowledge_problems - Potwierdzanie problemów;close_problems - Zamykanie problemów;execute_scripts - Wykonywanie skryptów;manage_api_tokens - Zarządzanie tokenami API.Możliwe wartości tylko dla użytkowników typu Admin i Super admin: edit_maintenance - Tworzenie i edycja okresów utrzymania;manage_scheduled_reports - Zarządzanie raportami okresowymi;manage_sla - Zarządzanie SLA. |
| status | integer | Czy dostęp do wykonania akcji jest włączony. Możliwe wartości: 0 - Wyłączone; 1 - (domyślne) Włączone. |