> 用户对象

以下对象与 user API直接相关.

> User object

The following objects are directly related to the user API.

用户

用户对象具有以下属性。

属性 类说明
useridstring(readonly) 用户的ID。
alias
(required)
string用户别名。
attempt_clocktimestamp(readonly) 最近一次登录失败的时间。
attempt_failedinteger(readonly) 最近失败的登录尝试次数。
attempt_ipstring(readonly) 最近一次失败的登录来源IP地址。
autologininteger允许自动登录。

可能的值:
0 - (default) 禁止自动登录;
1 -允许自动登录。
autologoutstring会话过期时间。 接受具有后缀的秒或时间单位。 如果设置为 0s, 用户登录会话永远不会过期。

默认: 15m.
langstring用户默认语言代码

默认: en_GB
namestring用户名.
refreshstring自动刷新时间间隔. 接受具有后缀的秒或时间单位。

默认: 30s.
rows_per_pageinteger每页显示的对象行数。

Default: 50.
surnamestring姓。
themestring用户的主题。

可能的值:
default - (default) system default;
blue-theme - Blue;
dark-theme - Dark.
typeinteger用户类型。

Possible values:
1 - (default) Zabbix user;
2 - Zabbix admin;
3 - Zabbix super admin.
urlstring在登录后将用户重定向到页面的URL。

User

The user object has the following properties.

PropertyTypeDescription
useridstring(readonly) ID of the user.
alias
(required)
stringUser alias.
attempt_clocktimestamp(readonly) Time of the last unsuccessful login attempt.
attempt_failedinteger(readonly) Recent failed login attempt count.
attempt_ipstring(readonly) IP address from where the last unsuccessful login attempt came from.
autologinintegerWhether to enable auto-login.

Possible values:
0 - (default) auto-login disabled;
1 - auto-login enabled.
autologoutstringUser session life time. Accepts seconds and time unit with suffix. If set to 0s, the session will never expire.

Default: 15m.
langstringLanguage code of the user’s language.

Default: en_GB.
namestringName of the user.
refreshstringAutomatic refresh period. Accepts seconds and time unit with suffix.

Default: 30s.
rows_per_pageintegerAmount of object rows to show per page.

Default: 50.
surnamestringSurname of the user.
themestringUser’s theme.

Possible values:
default - (default) system default;
blue-theme - Blue;
dark-theme - Dark.
typeintegerType of the user.

Possible values:
1 - (default) Zabbix user;
2 - Zabbix admin;
3 - Zabbix super admin.
urlstringURL of the page to redirect the user to after logging in.

媒体

媒体对象具有以下属性。

属性 类说明
mediatypeid
(required)
string用于媒体的媒体类型ID
sendto
(required)
string/array地址, 用户名或者接收方的其他标识符。

如果类型是 Media type 电子邮件, 值被设置为数组。 其他类型 Media types,值被设置为字符串。
activeinteger是否启用媒体。

可能的值:
0 - (default) enabled;
1 - disabled.
severityinteger触发发送通知告警级别。

Severities are stored in binary form with each bit representing the corresponding severity. For example, 12 equals 1100 in binary and means, that notifications will be sent from triggers with severities warning and average.

Refer to the trigger object page for a list of supported trigger severities.

Default: 63
periodstring当通知可以作为 time period 发送或者用分号隔开用户宏。

Default: 1-7,00:00-24:00

Media

The media object has the following properties.

PropertyTypeDescription
mediatypeid
(required)
stringID of the media type used by the media.
sendto
(required)
string/arrayAddress, user name or other identifier of the recipient.

If type of Media type is e-mail, values are represented as array. For other types of Media types, value is represented as a string.
activeintegerWhether the media is enabled.

Possible values:
0 - (default) enabled;
1 - disabled.
severityintegerTrigger severities to send notifications about.

Severities are stored in binary form with each bit representing the corresponding severity. For example, 12 equals 1100 in binary and means, that notifications will be sent from triggers with severities warning and average.

Refer to the trigger object page for a list of supported trigger severities.

Default: 63
periodstringTime when the notifications can be sent as a time period or user macros separated by a semicolon.

Default: 1-7,00:00-24:00