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 nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
mfaids ID/array Atgriezt tikai lietotāju grupas ar norādītajām MFA metodēm.

Parametra darbība:
- atbalstīts Super admin tipa lietotājiem
mfa_status integer Atgriezt tikai lietotāju grupas ar norādīto MFA statusu.

Atbalstīto statusu sarakstu skatiet lietotāju grupas lapā.
status integer Atgriezt tikai lietotāju grupas ar norādīto statusu.

Atbalstīto statusu sarakstu skatiet lietotāju grupas lapā.
userids ID/array Atgriezt tikai tās lietotāju grupas, kurās ir norādītie lietotāji.
usrgrpids ID/array Atgriezt tikai lietotāju grupas ar norādītajiem ID.
selectTagFilters query Atgriezt lietotāju grupas uz birkām balstītās atļaujas īpašībā tag_filters.
selectUsers query Atgriezt lietotājus no lietotāju grupas īpašībā users.

Skatiet user.get, lai uzzinātu par ierobežojumiem atkarībā no lietotāja tipa.
selectHostGroupRights query Atgriezt lietotāju grupas hostu grupu atļaujas īpašībā hostgroup_rights.

Hostu grupu piekļuves līmeņu sarakstu skatiet lietotāju grupas lapā.
selectTemplateGroupRights query Atgriezt lietotāju grupas veidņu grupu atļaujas īpašībā templategroup_rights.

Veidņu grupu piekļuves līmeņu sarakstu skatiet lietotāju grupas lapā.
limitSelects integer Ierobežo apakšatlases vaicājumu atgriezto ierakstu skaitu.
output query Atgriežamās lietotāju grupas objekta īpašības.

Admin un User tipa lietotāji var iegū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āros.
editable boolean
excludeSearch boolean
filter object
limit integer
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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.