user.get

Опис

integer/array user.get(object parameters)

Метода омогућава преузимање упозорења према датим параметрима.

Овај метод је доступан корисницима било које врсте. Дозволе за позивање методе може се опозвати у подешавањима улоге корисника. Погледајте Корисничке улоге за више информација.

Параметри

(објекат) Параметри који дефинишу жељени излаз.

Метода подржава следеће параметре.

Када захтевају корисничке медије, дозволе или информације о улогама, корисници типа Администратор и Корисник могу да преузму податке само о свом кориснику. На пример, погледајте Преузимање корисника као Администратор.

Parameter Type Description
mediaids ID/array Врати само кориснике који користе дате медије.
mediatypeids ID/array Врати само кориснике који користе дате типове медија.
userids ID/array Врати само кориснике са датим ИД-овима.
usrgrpids ID/array Врати само кориснике који припадају датим групама корисника.
getAccess flag Додаје додатне информације о корисничким дозволама.

Додаје следећа својства за сваког корисника:
gui_access - (integer) метод аутентификације корисника на фронтенду. Погледајте својство gui_access објекта корисничке групе за листу могућих вредности.
debug_mode - (integer) означава да ли је отклањање грешака омогућено за корисника. Могуће вредности: 0 - отклањање грешака онемогућено, 1 - отклањање грешака омогућено.
users_status - (integer) означава да ли је корисник онемогућен. Могуће вредности: 0 - корисник омогућен, 1 - корисник онемогућен.
selectMedias query Врати медије које је корисник користио у својству medias.
selectMediatypes query Врати типове медија које корисник користи у својству mediatypes.

Погледајте mediatype.get за ограничења на основу типа корисника.
selectUsrgrps query Врати групе корисника којима корисник припада у својству usrgrps.

Погледајте usergroup.get за ограничења на основу типа корисника.
selectRole query Врати улогу корисника у својству role.
filter object Враћа само оне резултате који се тачно подударају са датим филтером.

Прихвата објекат, где су кључеви имена својстава, а вредности су или једна вредност или низ вредности за упоређивање.

Не подржава својства text тип података.

Могућа својства User object за кориснике типа Admin и User приликом захтевања података о корисницима у њиховој корисничкој групи: userid, name, surname, username.
output query Објекат корисника својства која треба вратити.

Корисници типа Администратор и Корисник могу преузети само следећа својства:
- За свог корисника: userid, attempt_clock, attempt_failed, attempt_ip, autologin, autologout, lang, name, provisioned, refresh, roleid, rows_per_page, surname, theme, timezone, url, username.
- За кориснике у њиховој корисничкој групи: userid, name, surname, username.

Подразумевано: extend.
претрага објекат Враћа резултате који одговарају датом обрасцу (без разлике између великих и малих слова).

Прихвата објекат, где су кључеви имена својстава, а вредности су стрингови за претрагу. Ако нису дате додатне опције, извршиће се претрага LIKE "%…%".

Подржава само својства string и text тип података.

Могућа својства Кориснички објекат за кориснике типа Admin и User када се захтевају подаци о корисницима у њиховој корисничкој групи: name, surname, username.
sortfield string/array Сортира резултат по датим својствима.

Могуће вредности: userid, username.
countOutput boolean Ови параметри су описани у коментару референце.
editable boolean
excludeSearch boolean
limit integer
preservekeys boolean
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Повратне вредности

(integer/array) Враћа било:

  • низ објеката;
  • број преузетих објеката, ако је параметар countOutput коришћен.

Примери

Преузимање корисника

Преузмите све конфигурисане кориснике.

Захтев:

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

Одговор:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "userid": "1",
            "username": "Admin",
            "name": "Zabbix",
            "surname": "Administrator",
            "url": "",
            "autologin": "1",
            "autologout": "0",
            "lang": "en_US",
            "refresh": "0s",
            "theme": "default",
            "attempt_failed": "0",
            "attempt_ip": "",
            "attempt_clock": "0",
            "rows_per_page": "50",
            "timezone": "default",
            "roleid": "3",
            "userdirectoryid": "0",
            "ts_provisioned": "0"
        },
        {
            "userid": "2",
            "username": "guest",
            "name": "",
            "surname": "",
            "url": "",
            "autologin": "0",
            "autologout": "15m",
            "lang": "default",
            "refresh": "30s",
            "theme": "default",
            "attempt_failed": "0",
            "attempt_ip": "",
            "attempt_clock": "0",
            "rows_per_page": "50",
            "timezone": "default",
            "roleid": "4",
            "userdirectoryid": "0",
            "ts_provisioned": "0"
        },
        {
            "userid": "3",
            "username": "user",
            "name": "Zabbix",
            "surname": "User",
            "url": "",
            "autologin": "0",
            "autologout": "0",
            "lang": "ru_RU",
            "refresh": "15s",
            "theme": "dark-theme",
            "attempt_failed": "0",
            "attempt_ip": "",
            "attempt_clock": "0",
            "rows_per_page": "100",
            "timezone": "default",
            "roleid": "1",
            "userdirectoryid": "0",
            "ts_provisioned": "0"
        }
    ],
    "id": 1
}

Преузимање корисника као Администратор

Као корисник типа Администратор, преузмите детаљне податке о свом кориснику и ограничене податке за кориснике у вашој корисничкој групи.

Захтев:

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

Одговор :

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

Преузимање корисничких података

Преузмите податке корисника са ID-ијем "12".

Захтев:

{
    "jsonrpc": "2.0",
    "method": "user.get",
    "params": {
        "output": ["userid", "username"],
        "selectRole": "extend",
        "userids": "12"
    },
    "id": 1
}

Одговор:

{
  "jsonrpc": "2.0",
  "result": [
      {
          "userid": "12",
          "username": "John",
          "role": {
              "roleid": "5",
              "name": "Operator",
              "type": "1",
              "readonly": "0"
          }
      }
  ],
  "id": 1
}

Погледајте такође

Извор

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