user.get

Description

integer/array user.get(object parameters)

The method allows to retrieve users according to the given parameters.

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter Type Description
mediaids string/array Return only users that use the given media.
mediatypeids string/array Return only users that use the given media types.
userids string/array Return only users with the given IDs.
usrgrpids string/array Return only users that belong to the given user groups.
getAccess flag Adds additional information about user permissions. Adds the following properties for each user: guiaccess - (integer) user's frontend authentication method. Refer to the gui_access property of the user group object for a list of possible values. debug_mode - (integer) indicates whether debug is enabled for the user. Possible values: 0 - debug disabled, 1 - debug enabled. users_status - (integer)_ indicates whether the user is disabled. Possible values: 0 - user enabled, 1 - user disabled.
selectMedias query Return media used by the user in the medias property.
selectMediatypes query Return media types used by the user in the mediatypes property.
selectUsrgrps query Return user groups that the user belongs to in the usrgrps property.
sortfield string/array Sort the result by the given properties. Possible values are: userid and alias.
countOutput flagThese parameters being common for all get methods are described in detail in the reference commentary.
editable boolean
excludeSearch flag
filter object
limit integer
output query
preservekeys flag
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch flag

Return values

(integer/array) Returns either:

  • an array of objects;

  • the count of retrieved objects, if the countOutput parameter has been used.

Examples

Retrieving users

Retrieve all of the configured users.

Request:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "user.get",
  4.     "params": {
  5.         "output": "extend"
  6.     },
  7.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  8.     "id": 1
  9. }

Response:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": [
  4.         {
  5.             "userid": "1",
  6.             "alias": "Admin",
  7.             "name": "Zabbix",
  8.             "surname": "Administrator",
  9.             "url": "",
  10.             "autologin": "1",
  11.             "autologout": "0s",
  12.             "lang": "ru_RU",
  13.             "refresh": "0s",
  14.             "type": "3",
  15.             "theme": "default",
  16.             "attempt_failed": "0",
  17.             "attempt_ip": "",
  18.             "attempt_clock": "0",
  19.             "rows_per_page": "50"
  20.         },
  21.         {
  22.             "userid": "2",
  23.             "alias": "guest",
  24.             "name": "Default2",
  25.             "surname": "User",
  26.             "url": "",
  27.             "autologin": "0",
  28.             "autologout": "15m",
  29.             "lang": "en_GB",
  30.             "refresh": "30s",
  31.             "type": "1",
  32.             "theme": "default",
  33.             "attempt_failed": "0",
  34.             "attempt_ip": "",
  35.             "attempt_clock": "0",
  36.             "rows_per_page": "50"
  37.         }
  38.     ],
  39.     "id": 1
  40. }

See also

Source

CUser::get() in frontends/php/include/classes/api/services/CUser.php.