[comment]: # aside: 1

[comment]: # ({8f026b4a-0834cf88})
# Объект user

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

[comment]: # ({/8f026b4a-0834cf88})

[comment]: # ({730822db-0ecc45be})
### Пользователь

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

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|--|
|userid|ID|ID пользователя.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*<br>- *обязательно* для операций обновления|
|username|string|Имя пользователя.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *обязательно* для операций создания<br>- *только для чтения* для [подготовленных пользователей](/manual/web_interface/frontend_sections/users/authentication#default-authentication), если пользователь связан с [каталогом пользователей](/manual/api/reference/userdirectory/object) (`userdirectoryid` имеет допустимое значение, отличное от "0"), включено состояние подготовки каталога пользователей (`provision_status` объекта [User directory object](/manual/api/reference/userdirectory/object#userdirectory) установлено в "1"), и включено состояние аутентификации для всей подготовки LDAP или SAML (`ldap_jit_status` объекта [Authentication object](/manual/api/reference/authentication/object#authentication) установлено в "Enabled for configured LDAP IdPs" или `saml_jit_status` объекта [Authentication object](/manual/api/reference/authentication/object#authentication) установлено в "Enabled for configured SAML IdPs")|
|passwd|string|Пароль пользователя.<br><br>Значение этого параметра может быть пустой строкой, если пользователь связан с [каталогом пользователей](/manual/api/reference/userdirectory/object).<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для записи*|
|roleid|ID|ID роли пользователя.<br><br>Обратите внимание, что пользователи без роли могут входить в Zabbix только с использованием аутентификации [LDAP](/manual/web_interface/frontend_sections/users/authentication/ldap) или [SAML](/manual/web_interface/frontend_sections/users/authentication/saml), если их данные LDAP/SAML соответствуют сопоставлениям групп пользователей, настроенным в Zabbix.|
|attempt\_clock|timestamp|Время последней неудачной попытки входа.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*|
|attempt\_failed|integer|Количество недавних неудачных попыток входа.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*|
|attempt\_ip|string|IP-адрес, с которого была выполнена последняя неудачная попытка входа.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*|
|autologin|integer|Включать ли автоматический вход.<br><br>Возможные значения:<br>0 - *(по умолчанию)* автоматический вход отключен;<br>1 - автоматический вход включен.|
|autologout|string|Время жизни сеанса пользователя. Принимает секунды и единицу времени с суффиксом. Если установлено значение 0s, сеанс никогда не истечет.<br><br>По умолчанию: 15m.|
|lang|string|Код языка пользователя, например `en_US`.<br><br>По умолчанию: `default` - системный язык по умолчанию.|
|name|string|Имя пользователя.|
|provisioned|integer|Был ли пользователь [подготовлен](/manual/api/reference/user/provision).<br><br>Возможные значения:<br>0 - не подготовлен;<br>1 - подготовлен.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*|
|refresh|string|Период автоматического обновления. Принимает секунды или единицу времени с суффиксом (например, 30s, 90s, 1m, 1h).<br><br>По умолчанию: 30s.|
|rows\_per\_page|integer|Количество строк объекта, отображаемых на странице.<br><br>По умолчанию: 50.|
|surname|string|Фамилия пользователя.|
|theme|string|Тема пользователя.<br><br>Возможные значения:<br>`default` - *(по умолчанию)* системная тема по умолчанию;<br>`blue-theme` - Blue;<br>`dark-theme` - Dark;<br>`hc-light` - High-contrast light;<br>`hc-dark` - High-contrast dark.|
|ts_provisioned|timestamp|Время, когда была выполнена последняя операция [подготовки](/manual/api/reference/user/provision).<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*<br>- *поддерживается* для пользователей типа *Super admin*|
|url|string|URL страницы, на которую следует перенаправить пользователя после входа в систему.|
|userdirectoryid|ID|ID [каталога пользователей](/manual/api/reference/userdirectory/object), к которому привязан пользователь.<br><br>Используется для подготовки (создания или обновления), а также для входа пользователя, связанного с каталогом пользователей.<br><br>Для операций входа значение этого свойства будет иметь приоритет над свойством `userdirectoryid` [групп пользователей](/manual/api/reference/usergroup/object#user-group), к которым принадлежит пользователь.<br><br>По умолчанию: 0.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*<br>- *поддерживается* для пользователей типа *Super admin*|
|timezone|string|Часовой пояс пользователя, например `Europe/London`, `UTC`.<br><br>По умолчанию: `default` - системный часовой пояс по умолчанию.<br><br>Полный список поддерживаемых часовых поясов см. в [документации PHP](https://www.php.net/manual/en/timezones.php).|

[comment]: # ({/730822db-0ecc45be})

[comment]: # ({e65af01e-1ad487be})
### Media

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

|Property|Type|Description|
|--|--|------|
|mediaid|ID|ID media пользователя.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*|
|mediatypeid|ID|ID типа media, используемого media пользователя.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *обязательно*|
|sendto|string/array|Адрес, имя пользователя или другой идентификатор получателя.<br><br>Если `type` [типа media](/manual/api/reference/mediatype/object#mediatype) установлен в "Email", значения представляются как массив. Для других [типов media](/manual/api/reference/mediatype/object#mediatype) значение представляется как строка.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *обязательно*|
|active|integer|Включено ли media.<br><br>Возможные значения:<br>0 - *(по умолчанию)* включено;<br>1 - отключено.|
|severity|integer|Серьезности триггеров, о которых отправлять уведомления.<br><br>Возможные битовые значения:<br>1 - Не классифицировано;<br>2 - Информация;<br>4 - Предупреждение;<br>8 - Средняя;<br>16 - Высокая;<br>32 - Чрезвычайная.<br><br>Это поле является битовой маской; допустима любая сумма возможных битовых значений (например, 48 для Average, High и Disaster).<br><br>По умолчанию: 63.|
|period|string|Время, когда уведомления могут быть отправлены, в виде [временного периода](/manual/appendix/time_period) или пользовательских макросов, разделенных точкой с запятой.<br><br>По умолчанию: 1-7,00:00-24:00.|
|provisioned|integer|Был ли пользователь [подготовлен](/manual/api/reference/user/provision).<br><br>Возможные значения:<br>0 - не подготовлен;<br>1 - подготовлен.|
|userdirectory_mediaid|ID|ID сопоставления media каталога пользователей для подготовленного media.<br><br>[Поведение свойства](/manual/api/reference_commentary#property-behavior):<br>- *только для чтения*<br>- *поддерживается* для пользователей типа *Super admin*|

[comment]: # ({/e65af01e-1ad487be})
