Объект роли

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

Роль

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

Property Type Description
roleid ID ID роли.

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

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

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

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

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

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

Правила роли

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

Property Type Description
ui array Массив объектов UI element.
ui.default_access integer Включен ли доступ к новым элементам интерфейса.

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

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

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

Property behavior:
- supported if services.read.mode is set to "0"
services.read.tag object Массив объектов Service tag.

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

Property behavior:
- supported if services.read.mode is set to "0"
services.write.mode integer Доступ на чтение и запись к сервисам.

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

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

Property behavior:
- supported if services.write.mode is set to "0"
services.write.tag object Массив объектов Service tag.

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

Property behavior:
- supported if services.write.mode is set to "0"
modules array Массив объектов module.
modules.default_access integer Включен ли доступ к новым модулям.

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

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

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

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

Элемент интерфейса

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

Property Type Description
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 - Администрирование > Очередь.

Property behavior:
- required
status integer Включен ли доступ к элементу интерфейса.

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

Сервис

Property Type Description
serviceid ID ID службы.

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

Тег сервиса

Property Type Description
tag string Имя тега.

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

Property behavior:
- required
value string Значение тега.

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

Модуль

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

Property Type Description
moduleid ID ID модуля.

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

Возможные значения:
0 - Disabled;
1 - (default) Enabled.

Действие

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

Property Type Description
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 - Разрешить создание/редактирование медиа для пользователей.

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

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