[comment]: # translation:outdated

[comment]: # ({ce8d2bd2-ce8d2bd2})
# usergroup.get

[comment]: # ({/ce8d2bd2-ce8d2bd2})

[comment]: # ({31fb9be6-ef79b8a9})
### Apraksts

`integer/array usergroup.get(object parameters)`

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

::: noteclassic
Šī 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](/manual/web_interface/frontend_sections/users/user_roles).
:::

[comment]: # ({/31fb9be6-ef79b8a9})

[comment]: # ({5591bd09-4be9c06e})
### Parametri

`(object)` Parametri, kas nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

|Parametrs|[Tips](/manual/api/reference_commentary#data-types)|Apraksts|
|--|--|------|
|mfaids|ID/array|Atgriezt tikai lietotāju grupas ar norādītajām MFA metodēm.<br><br>[Parametra darbība](/manual/api/reference_commentary#parameter-behavior):<br>- *atbalstīts* *Super admin* tipa lietotājiem|
|mfa_status|integer|Atgriezt tikai lietotāju grupas ar norādīto MFA statusu.<br><br>Atbalstīto statusu sarakstu skatiet [lietotāju grupas lapā](object#user-group).|
|status|integer|Atgriezt tikai lietotāju grupas ar norādīto statusu.<br><br>Atbalstīto statusu sarakstu skatiet [lietotāju grupas lapā](object#user-group).|
|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`](/manual/api/reference/usergroup/object#tag-based-permission).|
|selectUsers|query|Atgriezt lietotājus no lietotāju grupas īpašībā [`users`](/manual/api/reference/user/object#user).<br><br>Skatiet [`user.get`](/manual/api/reference/user/get), lai uzzinātu par ierobežojumiem atkarībā no lietotāja tipa.|
|selectHostGroupRights|query|Atgriezt lietotāju grupas hostu grupu [atļaujas](/manual/api/reference/usergroup/object#permission) īpašībā `hostgroup_rights`.<br><br>Hostu grupu piekļuves līmeņu sarakstu skatiet [lietotāju grupas lapā](object#permission).|
|selectTemplateGroupRights|query|Atgriezt lietotāju grupas veidņu grupu [atļaujas](/manual/api/reference/usergroup/object#permission) īpašībā `templategroup_rights`.<br><br>Veidņu grupu piekļuves līmeņu sarakstu skatiet [lietotāju grupas lapā](object#permission).|
|limitSelects|integer|Ierobežo apakšatlases vaicājumu atgriezto ierakstu skaitu.|
|output|query|Atgriežamās [lietotāju grupas objekta](/manual/api/reference/usergroup/object) īpašības.<br><br>*Admin* un *User* tipa lietotāji var iegūt tikai šādas īpašības: `usrgrpid`, `name`, `gui_access`, `users_status`, `debug_mode`, `mfa_status`.<br><br>Noklusējums: `extend`.|
|sortfield|string/array|Kārtot rezultātu pēc norādītajām īpašībām.<br><br>Iespējamās vērtības: `usrgrpid`, `name`.|
|countOutput|boolean|Šie parametri ir aprakstīti [atsauces komentāros](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/5591bd09-4be9c06e})

[comment]: # ({7223bab1-7223bab1})
### 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`.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Piemēri

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({e685bea9-62cd5d8e})
#### Iespējoto lietotāju grupu izgūšana

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

[Pieprasījums](/manual/api#performing-requests):

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

Atbilde:

```json
{
    "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
}
```

[comment]: # ({/e685bea9-62cd5d8e})

[comment]: # ({039ccba1-039ccba1})
### Skatiet arī

-   [Lietotājs](/manual/api/reference/user/object#user)

[comment]: # ({/039ccba1-039ccba1})

[comment]: # ({e72b2ac9-e72b2ac9})
### Avots

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

[comment]: # ({/e72b2ac9-e72b2ac9})