Zabbix Documentation 1.8

3.04.04.24.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.4Guidelines

User Tools

Site Tools


Sidebar

api:user

User

Methods

Class containing methods for operations with users. Only super admins have access to all users.

MethodsDescription
get() Get user details
create() Create users
update() Update user details
updateProfile() Update user profile
delete() Delete users
addMedia() Add user media
updateMedia() Update user media
deleteMedia() Remove user media
authenticate() Authenticate
login() Login
logout() Logout

Object details

User

The table contains complete list of user attributes.

ParameterTypeDescriptionDetails
useridintegerUser ID
aliasstringLogin
namestringName
surnamestringSurname
passwdstringPassword md5
urlstringUrl to open after user login
autologinintegerAuto login
autologoutintegerAuto logout In seconds, 0 - disabled
langstringLocale
refreshintegerPage refresh period
typeintegerUser type
themestringTheme
attempt_failedintegerNumber of failed login attempts
attempt_ipstringLast used IP to login
attempt_clockintegerLast login attempt date
rows_per_pageintegerRows per page to show

The table contains complete list of user media attributes.

ParameterTypeDescriptionDetails
mediaidintegerUser media ID
useridintegerUser ID
mediatypeidintegerUser media type ID
sendtostringWhere to send
activeintegerEnabled or disabled this media
severityintegerTrigger severity bit arithmetics
periodstringUser media period

Common tasks

The table contains list of common user-related tasks and possible implementation using Zabbix API

TaskHOWTO
Add a user Use method user.create
Add a bunch of new users Use method user.create with array of User objects
Rename user Use method user.update, set “name”:“<new name>“
Retrieve user details by User IDs Use method user.get with parameter userids
Retrieve user details by User alias Use method user.get with parameter filter, specify “alias”:”<user alias>“