Объект user

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

Пользователь

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

Property Type Description
userid ID ID пользователя.

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

Поведение свойства:
- обязательно для операций создания
- только для чтения для подготовленных пользователей, если пользователь связан с каталогом пользователей (userdirectoryid установлен в допустимое значение, отличное от "0"), и включен статус подготовки каталога пользователей (provision_status объекта User directory object установлен в "1"), а также включен статус аутентификации для всех LDAP или SAML provisioning (ldap_jit_status объекта Authentication object установлен в "Enabled for configured LDAP IdPs" или saml_jit_status объекта Authentication object установлен в "Enabled for configured SAML IdPs")
passwd string Пароль пользователя.

Значение этого параметра может быть пустой строкой, если пользователь связан с каталогом пользователей.

Поведение свойства:
- только для записи
roleid ID ID роли пользователя.

Обратите внимание, что пользователи без роли могут входить в Zabbix только с использованием аутентификации LDAP или SAML, при условии, что их данные LDAP/SAML соответствуют сопоставлениям групп пользователей, настроенным в Zabbix.
attempt_clock timestamp Время последней неудачной попытки входа.

Поведение свойства:
- только для чтения
attempt_failed integer Количество недавних неудачных попыток входа.

Поведение свойства:
- только для чтения
attempt_ip string IP-адрес, с которого была выполнена последняя неудачная попытка входа.

Поведение свойства:
- только для чтения
autologin integer Включать ли автоматический вход.

Возможные значения:
0 - (по умолчанию) автоматический вход отключен;
1 - автоматический вход включен.
autologout string Время жизни пользовательской сессии. Принимает секунды и единицу времени с суффиксом. Если установлено значение 0s, сессия никогда не истечет.

По умолчанию: 15m.
lang string Код языка пользователя, например en_US.

По умолчанию: default - системное значение по умолчанию.
name string Имя пользователя.
provisioned integer Был ли пользователь подготовлен.

Возможные значения:
0 - не подготовлен;
1 - подготовлен.

Это свойство поддерживается начиная с Zabbix 7.0.9.

Поведение свойства:
- только для чтения
refresh string Период автоматического обновления. Принимает секунды или единицу времени с суффиксом (например, 30s, 90s, 1m, 1h).

По умолчанию: 30s.
rows_per_page integer Количество строк объекта, отображаемых на странице.

По умолчанию: 50.
surname string Фамилия пользователя.
theme string Тема пользователя.

Возможные значения:
default - (по умолчанию) системное значение по умолчанию;
blue-theme - Blue;
dark-theme - Dark;
hc-light - High-contrast light;
hc-dark - High-contrast dark.
ts_provisioned timestamp Время, когда была выполнена последняя операция подготовки.

Поведение свойства:
- только для чтения
- поддерживается для пользователей типа Super admin (начиная с Zabbix 7.0.9)
url string URL страницы, на которую будет перенаправлен пользователь после входа в систему.
userdirectoryid ID ID каталога пользователей, к которому привязан пользователь.

Используется для подготовки (создания или обновления), а также для входа пользователя, связанного с каталогом пользователей.

Для операций входа значение этого свойства будет иметь приоритет над свойством userdirectoryid групп пользователей, к которым принадлежит пользователь.

По умолчанию: 0.

Поведение свойства:
- только для чтения
- поддерживается для пользователей типа Super admin (начиная с Zabbix 7.0.9)
timezone string Часовой пояс пользователя, например Europe/London, UTC.

По умолчанию: default - системное значение по умолчанию.

Полный список поддерживаемых часовых поясов см. в документации PHP.

Media

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

Property Type Description
mediaid ID ID media пользователя.

Поведение свойства:
- только для чтения
mediatypeid ID ID типа media, используемого media пользователя.

Поведение свойства:
- обязательное
sendto string/array Адрес, имя пользователя или другой идентификатор получателя.

Если type Media type установлен в "Email", значения представляются как массив. Для других типов Media types значение представляется как строка.

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

Возможные значения:
0 - (по умолчанию) включено;
1 - отключено.
severity integer Серьезности триггеров, о которых отправлять уведомления.

Возможные битовые значения:
1 - Не классифицировано;
2 - Информация;
4 - Предупреждение;
8 - Средняя;
16 - Высокая;
32 - Чрезвычайная.

Это поле является битовой маской; допустима любая сумма возможных битовых значений (например, 48 для Средняя, Высокая и Чрезвычайная).

По умолчанию: 63.
period string Время, когда уведомления могут быть отправлены, в виде временного периода или макросов пользователя, разделенных точкой с запятой.

По умолчанию: 1-7,00:00-24:00.
provisioned integer Был ли пользователь подготовлен.

Возможные значения:
0 - не подготовлен;
1 - подготовлен.

Это свойство поддерживается начиная с Zabbix 7.0.9.
userdirectory_mediaid ID ID сопоставления media каталога пользователей для подготовленного media.

Поведение свойства:
- только для чтения
- поддерживается для пользователей типа Super admin (начиная с Zabbix 7.0.9)