user.get

Description

integer/array user.get(object parameters)

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

This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

ParameterTypeDescription
mediaidsstring/arrayReturn only users that use the given media.
mediatypeidsstring/arrayReturn only users that use the given media types.
useridsstring/arrayReturn only users with the given IDs.
usrgrpidsstring/arrayReturn only users that belong to the given user groups.
getAccessflagAdds additional information about user permissions.

Adds the following properties for each user:
gui_access - (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.
selectMediasqueryReturn media used by the user in the medias property.
selectMediatypesqueryReturn media types used by the user in the mediatypes property.
selectUsrgrpsqueryReturn user groups that the user belongs to in the usrgrps property.
selectRolequeryReturn user role in the role property.
sortfieldstring/arraySort the result by the given properties.

Possible values: userid, username.
countOutputbooleanThese parameters being common for all get methods are described in detail in the reference commentary.
editableboolean
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

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.            "id": 1
  8.        }

Response:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "result": [
  4.                {
  5.                    "userid": "1",
  6.                    "username": "Admin",
  7.                    "name": "Zabbix",
  8.                    "surname": "Administrator",
  9.                    "url": "",
  10.                    "autologin": "1",
  11.                    "autologout": "0",
  12.                    "lang": "en_GB",
  13.                    "refresh": "0s",
  14.                    "theme": "default",
  15.                    "attempt_failed": "0",
  16.                    "attempt_ip": "",
  17.                    "attempt_clock": "0",
  18.                    "rows_per_page": "50",
  19.                    "timezone": "default",
  20.                    "roleid": "3",
  21.                    "userdirectoryid": "0",
  22.                    "ts_provisioned": "0"
  23.                },
  24.                {
  25.                    "userid": "2",
  26.                    "username": "guest",
  27.                    "name": "",
  28.                    "surname": "",
  29.                    "url": "",
  30.                    "autologin": "0",
  31.                    "autologout": "15m",
  32.                    "lang": "default",
  33.                    "refresh": "30s",
  34.                    "theme": "default",
  35.                    "attempt_failed": "0",
  36.                    "attempt_ip": "",
  37.                    "attempt_clock": "0",
  38.                    "rows_per_page": "50",
  39.                    "timezone": "default",
  40.                    "roleid": "4",
  41.                    "userdirectoryid": "0",
  42.                    "ts_provisioned": "0"
  43.                },
  44.                {
  45.                    "userid": "3",
  46.                    "username": "user",
  47.                    "name": "Zabbix",
  48.                    "surname": "User",
  49.                    "url": "",
  50.                    "autologin": "0",
  51.                    "autologout": "0",
  52.                    "lang": "ru_RU",
  53.                    "refresh": "15s",
  54.                    "theme": "dark-theme",
  55.                    "attempt_failed": "0",
  56.                    "attempt_ip": "",
  57.                    "attempt_clock": "0",
  58.                    "rows_per_page": "100",
  59.                    "timezone": "default",
  60.                    "roleid": "1",
  61.                    "userdirectoryid": "0",
  62.                    "ts_provisioned": "0"
  63.                }
  64.            ],
  65.            "id": 1
  66.        }

Retrieving user data

Retrieve data of a user with ID “12”.

Request:

  1. {
  2.            "jsonrpc": "2.0",
  3.            "method": "user.get",
  4.            "params": {
  5.                "output": ["userid", "username"],
  6.                "selectRole": "extend",
  7.                "userids": "12"
  8.            },
  9.            "id": 1
  10.        }

Response:

  1. {
  2.          "jsonrpc": "2.0",
  3.          "result": [
  4.              {
  5.                  "userid": "12",
  6.                  "username": "John",
  7.                  "role": {
  8.                      "roleid": "5",
  9.                      "name": "Operator",
  10.                      "type": "1",
  11.                      "readonly": "0"
  12.                  }
  13.              }
  14.          ],
  15.          "id": 1
  16.        }

See also

Source

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