usergroup.get

Apraksts

integer/array usergroup.get(object parameters)

Metode ļauj iegūt lietotāju grupas atbilstoši norādītajiem parametriem.

Šī metode ir pieejama jebkura tipa lietotājiem. Atļaujas izsaukt šo metodi var tikt atsauktas lietotāja lomas iestatījumos. Plašāku informāciju skatiet sadaļā Lietotāju lomas.

Parametri

(object) Parametri, kas definē vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parameter Type Description
mfaids ID/array Atgriezt tikai lietotāju grupas ar norādītajām MFA metodēm.

Parametra darbība:
- supported priekš Super admin tipa lietotājiem (kopš Zabbix 7.0.9)
mfa_status integer Atgriezt tikai lietotāju grupas ar norādīto MFA statusu.

Skatiet lietotāju grupas lapu atbalstīto statusu sarakstam.
status integer Atgriezt tikai lietotāju grupas ar norādīto statusu.

Skatiet lietotāju grupas lapu atbalstīto statusu sarakstam.
userids ID/array Atgriezt tikai lietotāju grupas, kas satur norādītos lietotājus.
usrgrpids ID/array Atgriezt tikai lietotāju grupas ar norādītajiem ID.
selectTagFilters query Atgriezt lietotāju grupas uz tagiem balstītās atļaujas tag_filters īpašībā.
selectUsers query Atgriezt lietotājus no lietotāju grupas users īpašībā.

Skatiet user.get ierobežojumus, kas balstīti uz lietotāja tipu.
selectHostGroupRights query Atgriezt lietotāju grupas hosts grupu atļaujas hostgroup_rights īpašībā.

Skatiet lietotāju grupas lapu hosts grupu piekļuves līmeņu sarakstam.
selectTemplateGroupRights query Atgriezt lietotāju grupas veidņu grupu atļaujas templategroup_rights īpašībā.

Skatiet lietotāju grupas lapu veidņu grupu piekļuves līmeņu sarakstam.
limitSelects integer Ierobežo ierakstu skaitu, ko atgriež apakšatlases.
output query Lietotāju grupas objekta īpašības, kas jāatgriež.

Kopš Zabbix 7.0.9, Admin un User tipa lietotāji var izgūt tikai šādas īpašības: usrgrpid, name, gui_access, users_status, debug_mode, mfa_status.

Noklusējums: extend.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: usrgrpid, name.
countOutput boolean Šie parametri ir aprakstīti atsauces komentārā.
editable boolean
excludeSearch boolean
filter object
limit integer
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectRights
(deprecated)		 query Šis parametrs ir novecojis, lūdzu, tā vietā izmantojiet selectHostGroupRights vai selectTemplateGroupRights.
Atgriezt lietotāju grupas tiesības rights īpašībā.
Skatiet lietotāju grupas lapu hosts grupu piekļuves līmeņu sarakstam.

Atgrieztās vērtības

(integer/array) Atgriež vienu no šīm vērtībām:

  • objektu masīvu;
  • iegūto objektu skaitu, ja ir izmantots parametrs countOutput.

Piemēri

Iespējoto lietotāju grupu izgūšana

Izgūst visas iespējotās lietotāju grupas.

Pieprasījums:

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

Atbilde:

{
    "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": "Enabled debug mode",
            "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",
            "users_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        }
    ],
    "id": 1
}

Skatiet arī

Avots

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