Zabbix Documentation 4.0

3.04.04.45.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


Sidebar

zh:manual:api:reference:user:object

> 用户对象

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

> User object

The following objects are directly related to the user API.

用户

用户对象具有以下属性。

属性 类型 说明
userid string (readonly) 用户的ID。
alias
(required)
string 用户别名。
attempt_clock timestamp (readonly) 最近一次登录失败的时间。
attempt_failed integer (readonly) 最近失败的登录尝试次数。
attempt_ip string (readonly) 最近一次失败的登录来源IP地址。
autologin integer 允许自动登录。

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

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

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

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

Default: 50.
surname string 姓。
theme string 用户的主题。

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

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

User

The user object has the following properties.

Property Type Description
userid string (readonly) ID of the user.
alias
(required)
string User alias.
attempt_clock timestamp (readonly) Time of the last unsuccessful login attempt.
attempt_failed integer (readonly) Recent failed login attempt count.
attempt_ip string (readonly) IP address from where the last unsuccessful login attempt came from.
autologin integer Whether to enable auto-login.

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

Default: 15m.
lang string Language code of the user's language.

Default: en_GB.
name string Name of the user.
refresh string Automatic refresh period. Accepts seconds and time unit with suffix.

Default: 30s.
rows_per_page integer Amount of object rows to show per page.

Default: 50.
surname string Surname of the user.
theme string User's theme.

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

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

媒体

媒体对象具有以下属性。

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

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

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

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
period string 当通知可以作为 time period 发送或者用分号隔开用户宏。

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

Media

The media object has the following properties.

Property Type Description
mediatypeid
(required)
string ID of the media type used by the media.
sendto
(required)
string/array Address, 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.
active integer Whether the media is enabled.

Possible values:
0 - (default) enabled;
1 - disabled.
severity integer Trigger 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
period string Time when the notifications can be sent as a time period or user macros separated by a semicolon.

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