usergroup.get

Опис

integer/array usergroup.get(object parameters)

Метод омогућава преузимање корисничких група према датим параметрима.

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

Параметри

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

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

Parameter Type Description
mfaids ID/array Враћа само корисничке групе са датим MFA методама.

Понашање параметра:
- подржано за кориснике типа Супер администратор
mfa_status integer Враћа само корисничке групе са датим MFA статусом.

Погледајте страницу корисничких група за листу подржаних статуса.
status integer Врати само групе корисника са датим статусом.

Погледајте страницу групе корисника за листу подржаних статуса.
userids ID/array Врати само групе корисника које садрже дате кориснике.
usrgrpids ID/array Врати само групе корисника са датим ID-овима.
selectTagFilters query Врати дозволе групе корисника засноване на ознакама у својству tag_filters.
selectUsers query Врати кориснике из групе корисника у својству users.

Погледајте user.get за ограничења заснована на типу корисника.
selectHostGroupRights query Врати групу корисника host group permissions у својству hostgroup_rights.

Погледајте страницу групе корисника за листу нивоа приступа групама хостова.
selectTemplateGroupRights query Врати групу корисника шаблона групе permissions у својству templategroup_rights.

Погледајте страницу групе корисника за листу нивоа приступа групама шаблона.
limitSelects integer Ограничава број записа које враћају подизбори.
output query Објекат групе корисника својства која треба вратити.

Корисници типа Администратор и Корисник могу преузети само следећа својства: usrgrpid, name, gui_access, users_status, debug_mode, mfa_status.

Подразумевано: extend.
sortfield string/array Сортира резултат по датим својствима.

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

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

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

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

Примери

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

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

Захтев:

{
           "jsonrpc": "2.0",
           "method": "usergroup.get",
           "params": {
               "output": "extender",
               "status": 0
           },
           "id": 1
       }

Одговор:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "usrgrpid": "7",
                   "name": "Zabbix administrators",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "1",
                   "userdirectoryid": "0",
                   "mfa_status": "0",
                   "mfaid": "0"
               },
               {
                   "usrgrpid": "8",
                   "name": "Guests",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0",
                   "mfa_status": "0",
                   "mfaid": "0"
               },
               {
                   "usrgrpid": "11",
                   "name": "Modo de depuración habilitado",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "1",
                   "userdirectoryid": "0",
                   "mfa_status": "0",
                   "mfaid": "0"
               },
               {
                   "usrgrpid": "12",
                   "name": "No access to the frontend",
                   "gui_access": "2",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0",
                   "mfa_status": "0",
                   "mfaid": "0"
               },
               {
                   "usrgrpid": "14",
                   "name": "Read only",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0",
                   "mfa_status": "0",
                   "mfaid": "0"
               },
               {
                   "usrgrpid": "18",
                   "name": "Deny",
                   "gui_access": "0",
                   "usuarios_status": "0",
                   "debug_mode": "0",
                   "userdirectoryid": "0",
                   "mfa_status": "0",
                   "mfaid": "0"
               }
           ],
           "id": 1
       }

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

Извор

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