Объект role

Следующие объекты напрямую связаны с API role.

Роль

Объект роли имеет следующие свойства:

Свойство Тип Описание
roleid ID ID роли.

Поведение свойства:
- только для чтения
- обязательно для операций обновления
name string Имя роли.

Поведение свойства:
- обязательно для операций создания
type integer Тип пользователя.

Возможные значения:
1 - (по умолчанию) Пользователь;
2 - Администратор;
3 - Супер-администратор.

Поведение свойства:
- обязательно для операций создания
readonly integer Указывает, является ли роль доступной только для чтения.

Возможные значения:
0 - (по умолчанию) Нет;
1 - Да.

Поведение свойства:
- только для чтения

Правила роли

Объект правил роли имеет следующие свойства:

Свойство Type Описание
ui array Массив объектов элемента пользовательского интерфейса.
ui.default_access integer Включен ли доступ к новым элементам пользовательского интерфейса.

Возможные значения:
0 - Отключено;
1 - (по умолчанию) Включено.
services.read.mode integer Доступ только на чтение к сервисам.

Возможные значения:
0 - Доступ только на чтение к сервисам, указанным в свойстве services.read.list или соответствующим свойству services.read.tag;
1 - (по умолчанию) Доступ только на чтение ко всем сервисам.
services.read.list array Массив объектов Service.

Указанным сервисам, включая дочерние сервисы, будет предоставлен доступ только на чтение для роли пользователя. Доступ только на чтение не переопределяет доступ на чтение и запись к сервисам.

Поведение свойства:
- поддерживается, если services.read.mode установлено в "0"
services.read.tag object Массив объектов тега сервиса.

Сервисам, соответствующим тегу, включая дочерние сервисы, будет предоставлен доступ только на чтение для роли пользователя. Доступ только на чтение не переопределяет доступ на чтение и запись к сервисам.

Поведение свойства:
- поддерживается, если services.read.mode установлено в "0"
services.write.mode integer Доступ на чтение и запись к сервисам.

Возможные значения:
0 - (по умолчанию) Доступ на чтение и запись к сервисам, указанным в свойстве services.write.list или соответствующим свойству services.write.tag;
1 - Доступ на чтение и запись ко всем сервисам.
services.write.list array Массив объектов Service.

Указанным сервисам, включая дочерние сервисы, будет предоставлен доступ на чтение и запись для роли пользователя. Доступ на чтение и запись переопределяет доступ только на чтение к сервисам.

Поведение свойства:
- поддерживается, если services.write.mode установлено в "0"
services.write.tag object Массив объектов тега сервиса.

Сервисам, соответствующим тегу, включая дочерние сервисы, будет предоставлен доступ на чтение и запись для роли пользователя. Доступ на чтение и запись переопределяет доступ только на чтение к сервисам.

Поведение свойства:
- поддерживается, если services.write.mode установлено в "0"
modules array Массив объектов модуля.
modules.default_access integer Включен ли доступ к новым модулям.

Возможные значения:
0 - Отключено;
1 - (по умолчанию) Включено.
api.access integer Включен ли доступ к API.

Возможные значения:
0 - Отключено;
1 - (по умолчанию) Включено.
api.mode integer Режим обработки методов API, перечисленных в свойстве api.

Возможные значения:
0 - (по умолчанию) Список запрещённых;
1 - Список разрешённых.
api array Массив методов API.
actions array Массив объектов операции.
actions.default_access integer Включен ли доступ к новым операциям.

Возможные значения:
0 - Отключено;
1 - (по умолчанию) Включено.

Элемент пользовательского интерфейса

Объект элемента пользовательского интерфейса имеет следующие свойства:

Свойство Тип Описание
name string Имя элемента пользовательского интерфейса.

Возможные значения, если type объекта Role задан как "User", "Admin" или "Super admin":
monitoring.dashboard - Панели;
monitoring.problems - Мониторинг → Проблемы;
monitoring.hosts - Мониторинг → Узлы сети;
monitoring.latest_data - Мониторинг → Последние данные;
monitoring.maps - Мониторинг → Карты;
services.services - Сервисы → Сервисы;
services.sla_report - Сервисы → Отчет SLA;
inventory.overview - Инвентаризация → Обзор;
inventory.hosts - Инвентаризация → Узлы сети;
reports.availability_report - Отчеты → Отчет о доступности;
reports.top_triggers - Отчеты → Топ 100 триггеров.

Возможные значения, если type объекта Role задан как "Admin" или "Super admin":
monitoring.discovery - Мониторинг → Обнаружение;
services.sla - Сервисы → SLA;
reports.scheduled_reports - Отчеты → Запланированные отчеты;
reports.notifications - Отчеты → Уведомления;
configuration.template_groups - Сбор данных → Группы шаблонов;
configuration.host_groups - Сбор данных → Группы узлов сети;
configuration.templates - Сбор данных → Шаблоны;
configuration.hosts - Сбор данных → Узлы сети;
configuration.maintenance - Сбор данных → Обслуживание;
configuration.discovery - Сбор данных → Обнаружение;
configuration.trigger_actions - Оповещения → Действия → Действия триггеров;
configuration.service_actions - Оповещения → Действия → Действия сервисов;
configuration.discovery_actions - Оповещения → Действия → Действия обнаружения;
configuration.autoregistration_actions - Оповещения → Действия → Действия авторегистрации;
configuration.internal_actions - Оповещения → Действия → Внутренние действия.

Возможные значения, если type объекта Role задан как "Super admin":
reports.system_info - Отчеты → Информация о системе;
reports.audit - Отчеты → Журнал аудита;
reports.action_log - Отчеты → Журнал действий;
configuration.event_correlation - Сбор данных → Корреляция событий;
administration.media_types - Оповещения → Способы оповещения;
administration.scripts - Оповещения → Скрипты;
administration.user_groups - Пользователи → Группы пользователей;
administration.user_roles - Пользователи → Роли пользователей;
administration.users - Пользователи → Пользователи;
administration.api_tokens - Пользователи → Токены API;
administration.authentication - Пользователи → Аутентификация;
administration.general - Администрирование → Общие;
administration.audit_log - Администрирование → Журнал аудита;
administration.housekeeping - Администрирование → Очистка истории;
administration.proxy_groups - Администрирование → Группы прокси;
administration.proxies - Администрирование → Прокси;
administration.macros - Администрирование → Макросы;
administration.queue - Администрирование → Очередь.

Поведение свойства:
- обязательное
status integer Включен ли доступ к элементу пользовательского интерфейса.

Возможные значения:
0 - Отключено;
1 - (по умолчанию) Включено.

Сервис

Свойство Тип Описание
serviceid ID ID сервиса.

Поведение свойства:
- обязательно

Тег сервиса

Свойство Type Описание
tag string Имя тега.

Если указана пустая строка, тег сервиса не будет использоваться для сопоставления сервисов.

Поведение свойства:
- обязательно
value string Значение тега.

Если значение не указано или указана пустая строка, для сопоставления сервисов будет использоваться только имя тега.

Модуль

Объект модуля имеет следующие свойства:

Свойство Тип Описание
moduleid ID ID модуля.

Поведение свойства:
- обязательно
status integer Включен ли доступ к модулю.

Возможные значения:
0 - Отключено;
1 - (по умолчанию) Включено.

Действие

Объект действия имеет следующие свойства:

Свойство Тип Описание
name string Имя действия.

Возможные значения, если type объекта Role установлен в "User", "Admin" или "Super admin":
edit_dashboards - создание и редактирование панелей;
edit_maps - создание и редактирование карт;
add_problem_comments - добавление комментариев к проблемам;
change_severity - изменение важности проблемы;
acknowledge_problems - подтверждение проблем;
suppress_problems - подавление проблем;
close_problems - закрытие проблем;
execute_scripts - выполнение скриптов;
manage_api_tokens - управление API-токенами;
change_problem_ranking - изменение ранга проблемы с причины на симптом и наоборот;
edit_own_media - разрешить создание/редактирование собственных способов оповещения.

Возможные значения, если type объекта Role установлен в "Admin" или "Super admin":
edit_maintenance - создание и редактирование периодов обслуживания;
manage_scheduled_reports - управление запланированными отчетами,
manage_sla - управление SLA.

Возможные значения, если type объекта Role установлен в "User" или "Admin":
invoke_execute_now - позволяет выполнять проверки элементов данных для пользователей, у которых есть только права на чтение узла сети.

Возможные значения, если type объекта Role установлен в "Super admin":
edit_user_media - разрешить создание/редактирование способов оповещения для пользователей.

Поведение свойства:
- обязательно
status integer Включен ли доступ на выполнение действия.

Возможные значения:
0 - Отключено;
1 - (по умолчанию) Включено.