user.get

Описание

целое число/массив user.get(объект параметры)

Этот метод позволяет получать пользователей в соответствии с заданными параметрами.

Параметры

(объект) Параметры задают желаемый вывод.

Этот метод поддерживает следующие параметры.

Параметр	Тип	Описание
mediaids	строка/массив	Возврат только тех пользователей, которые используют заданные оповещения пользователя.
mediatypeids	строка/массив	Возврат только тех пользователей, которые используют заданные способы оповещения.
userids	строка/массив	Возврат пользователей только с заданными ID.
usrgrpids	строка/массив	Возврат только тех пользователей, которые принадлежат заданным группам пользователей.
getAccess	флаг	Добавление дополнительной информации о правах доступа пользователя. Добавление следующих свойств каждому пользователю: `gui_access` - (целое число) метод аутентификации пользователя в веб-интерфейсе. Обратитесь к свойству `gui_access` объекта группы пользователей для получения списка возможных значений. `debug_mode` - (целое число) указывает, активирован ли пользователю режим отладки. Возможные значения: 0 - режим отладки деактивирован, 1 - режим отладки активирован. `users_status` - (целое число) указывет, активирован ли пользователь. Возможные значения: 0 - пользователь активирован, 1 - пользователь деактивирован.
selectMedias	запрос	Возврат оповещений пользователея, которые используются пользователем, в свойстве `medias`.
selectMediatypes	запрос	Возврат способов оповещения, которые используются пользователем, в свойстве `mediatypes`.
selectUsrgrps	запрос	Возврат групп пользователей, которым принадлежат пользователи, в свойстве `usrgrps`.
sortfield	строка/массив	Сортировка результата в соответствии с заданными свойствами. Возможные значения: `userid` и `alias`.
countOutput	логический	Эти параметры являются общими для всех методов `get` и они описаны в справочных комментариях.
editable	логический
excludeSearch	логический
filter	объект
limit	целое число
output	запрос
preservekeys	логический
search	объект
searchByAny	логический
searchWildcardsEnabled	логический
sortorder	строка/массив
startSearch	логический

Возвращаемые значения

(целое число/массив) Возвращает либо:

массив объектов;
количество найденных объектов, если используется параметр countOutput.

Примеры

Получение пользователей

Получение всех добавленных пользователей.

Запрос:

{
           "jsonrpc": "2.0",
           "method": "user.get",
           "params": {
               "output": "extend"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "userid": "1",
                   "alias": "Admin",
                   "name": "Zabbix",
                   "surname": "Administrator",
                   "url": "",
                   "autologin": "1",
                   "autologout": "0s",
                   "lang": "ru_RU",
                   "refresh": "0s",
                   "type": "3",
                   "theme": "default",
                   "attempt_failed": "0",
                   "attempt_ip": "",
                   "attempt_clock": "0",
                   "rows_per_page": "50"
               },
               {
                   "userid": "2",
                   "alias": "guest",
                   "name": "Default2",
                   "surname": "User",
                   "url": "",
                   "autologin": "0",
                   "autologout": "15m",
                   "lang": "en_GB",
                   "refresh": "30s",
                   "type": "1",
                   "theme": "default",
                   "attempt_failed": "0",
                   "attempt_ip": "",
                   "attempt_clock": "0",
                   "rows_per_page": "50"
               }
           ],
           "id": 1
       }

Retrieving users as Admin

As an Admin type user, retrieve detailed data about your own user and limited data for users in your user group.

Request:

{
           "jsonrpc": "2.0",
           "method": "user.get",
           "params": {
               "output": "extend",
               "getAccess": true,
               "selectMedias": "extend",
               "selectMediatypes": "extend",
               "selectUsrgrps": "extend"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "userid": "1",
                   "alias": "Admin",
                   "name": "Zabbix",
                   "surname": "Administrator",
                   "usrgrps": [
                       {
                           "usrgrpid": "7",
                           "name": "Zabbix administrators",
                           "gui_access": "0",
                           "users_status": "0",
                           "debug_mode": "0"
                       }
                   ]
               },
               {
                   "userid": "3",
                   "alias": "database-admin",
                   "name": "John",
                   "surname": "Doe",
                   "url": "",
                   "autologin": "0",
                   "autologout": "0",
                   "lang": "en_GB",
                   "refresh": "30s",
                   "type": "2",
                   "theme": "default",
                   "attempt_failed": "0",
                   "attempt_ip": "",
                   "attempt_clock": "0",
                   "rows_per_page": "50",
                   "gui_access": "0",
                   "debug_mode": "0",
                   "users_status": "0",
                   "usrgrps": [
                       {
                           "usrgrpid": "7",
                           "name": "Zabbix administrators",
                           "gui_access": "0",
                           "users_status": "0",
                           "debug_mode": "0"
                       }
                   ],
                   "medias": [
                       {
                           "mediaid": "2",
                           "userid": "3",
                           "mediatypeid": "1",
                           "sendto": [
                               "[email protected]"
                           ],
                           "active": "0",
                           "severity": "63",
                           "period": "1-7,00:00-24:00"
                       }
                   ],
                   "mediatypes": [
                       {
                           "mediatypeid": "1",
                           "type": "0",
                           "name": "Email",
                           "status": "0",
                           "description": "",
                           "maxattempts": "3"
                       }
                   ]
               }
           ],
           "id": 1
       }

Смотрите также

Исходный код

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

Documentation