Объект роли

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

Роль

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

Property Type Description
roleid ID ID роли.

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

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

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

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

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

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

Правила роли

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

Свойство Тип Описание
ui array Массив объектов элементов веб-интерфейса.
ui.default_access integer Определяет, разрешен ли доступ к новым элементам веб-интерфейса.

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

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

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

Поведение свойства:
- поддерживается, если для 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 Массив объектов сервисов.

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

Поведение свойства:
- поддерживается, если для 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 - (по умолчанию) Включен.
devices.access integer Определяет, разрешен ли доступ к собственным мобильным устройствам пользователя для использования с мобильным приложением Zabbix.

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

Поведение свойства:
- поддерживается, если включен параметр EnableMobileDevices
devices.actions array Массив объектов действий с устройствами.

Поведение свойства:
- поддерживается, если для devices.access установлено значение "1"
devices.actions.default_access integer Определяет, разрешен ли доступ к новым действиям с устройствами.

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

Поведение свойства:
- поддерживается, если включен параметр EnableMobileDevices

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

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

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.linked_devices - Пользователи > Устройства;
administration.general - Администрирование > Общие параметры;
administration.audit_log - Администрирование > Журнал аудита;
administration.housekeeping - Администрирование > Очистка данных;
administration.proxy_groups - Администрирование > Группы прокси;
administration.proxies - Администрирование > Прокси;
administration.macros - Администрирование > Макросы;
administration.queue - Администрирование > Очередь.

Поведение свойства:
- обязательное
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.

Действие

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

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,
select_server_for_monitoring - Разрешение пользователям создавать узлы сети, отслеживаемые сервером, а также правилами обнаружения сети, выполняемыми сервером.

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

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

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

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

Действие с устройством

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

Property Type Description
name string Название действия с устройством.

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

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

Поведение свойства:
- required
status integer Определяет, разрешен ли доступ для выполнения действия.

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