usergroup.get

Apraksts

integer/array usergroup.get(object parameters)

Šī metode ļauj izgūt lietotāju grupas atbilstoši norādītajiem parametriem.

Šī metode ir pieejama jebkura tipa lietotājiem. Tiesības izsaukt šo metodi var atsaukt 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ā.
proxyids ID/array Atgriezt tikai lietotāju grupas, kurās ir norādītie starpniekserveri.

Parametra darbība:
- atbalstīts Super admin tipa lietotājiem.
proxy_groupids ID/array Atgriezt tikai lietotāju grupas, kurās ir norādītās starpniekserveru grupas.

Parametra darbība:
- atbalstīts Super admin tipa lietotājiem.
selectProxies ID/array Atgriezt proxies rekvizītu ar lietotāju grupu starpniekserveriem.

Parametra darbība:
- atbalstīts Super admin tipa lietotājiem.
selectProxyGroups ID/array Atgriezt proxy_groups rekvizītu ar lietotāju grupu starpniekserveru grupām.

Parametra darbība:
- atbalstīts Super admin tipa lietotājiem.
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 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 grupu uz tagiem balstītās atļaujas tag_filters rekvizītā.
selectApmFilters query Atgriezt lietotāju grupu uz APM balstītās atļaujas apm_filters rekvizītā.

Atbalstītie rekvizīti: key, value, signal_type.

Noklusējums: extend.
selectUsers query Atgriezt lietotājus no lietotāju grupas users rekvizītā.

Informāciju par ierobežojumiem atkarībā no lietotāja tipa skatiet user.get.
selectHostGroupRights query Atgriezt lietotāju grupas atļaujas attiecībā uz hostu grupām hostgroup_rights rekvizītā.

Piekļuves līmeņu sarakstu hostu grupām skatiet lietotāju grupas lapā.
selectTemplateGroupRights query Atgriezt lietotāju grupas atļaujas attiecībā uz veidņu grupām templategroup_rights rekvizītā.

Piekļuves līmeņu sarakstu veidņu grupām skatiet lietotāju grupas lapā.
limitSelects integer Ierobežo apakšatlases atgriezto ierakstu skaitu.
output query Atgriežamie lietotāju grupas objekta rekvizīti.

Admin un User tipa lietotāji var izgūt tikai šādus rekvizītus: usrgrpid, name, gui_access, users_status, debug_mode, mfa_status.

Noklusējums: extend.
sortfield string/array Kārtot rezultātu pēc norādītajiem rekvizītiem.

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.