Объект user

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

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

Объект пользователя имеет следующие свойства.

Property Type Description
userid ID Идентификатор пользователя.

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

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

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

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

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

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

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

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

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

По умолчанию: 15m.
default_maintenance_period string Период обслуживания по умолчанию для обслуживания, созданного с помощью ярлыка. Принимает количество секунд или единицу времени с суффиксом (300s, 5m, 1h, 1d, 1w). Указанное значение округляется вниз до целых минут.

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

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

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

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

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

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

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

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

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

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

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

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

По умолчанию: default - системный часовой пояс по умолчанию.

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

Мультимедиа

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

Property Type Description
mediaid ID Идентификатор мультимедиа пользователя.

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

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

Если для type типа мультимедиа установлено значение "Email" или "Push", значения представлены в виде массива. Для "Push" массив может содержать либо подстановочный знак (*), либо один или несколько идентификаторов мобильных устройств.

Если для type типа мультимедиа установлено значение "Script", "SMS" или "Webhook", значение представлено в виде строки.

Поведение свойства:
- обязательное
active integer Указывает, включено ли мультимедиа.

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

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

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

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

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

Возможные значения:
0 - не подготовлен;
1 - подготовлен.
userdirectory_mediaid ID Идентификатор сопоставления мультимедиа каталога пользователей для подготовленного мультимедиа.

Поведение свойства:
- только для чтения
- поддерживается для пользователей типа Суперадминистратор