[comment]: # translation:outdated

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

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

[comment]: # ({ef79b8a9-ef79b8a9})
### Beschrijving

`integer/array gebruikersgroep.get(objectparameters)`

De methode maakt het mogelijk om gebruikersgroepen op te halen volgens de gegeven
parameters.

::: noteclassic
Deze methode is beschikbaar voor gebruikers van elk type. Rechten
om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie [Gebruiker
rollen](/manual/web_interface/frontend_sections/administration/user_roles)
voor meer informatie.
:::

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

[comment]: # ({ec24a83b-4be9c06e})
### Parameters

`(object)` Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

|Parameter|[Type](/manual/api/reference_commentary#data_types)|Beschrijving|
|--|--|------|
|status|integer|Retourneer alleen gebruikersgroepen met de opgegeven status.<br><br>Raadpleeg de [pagina met gebruikersgroepen](object#user_group) voor een lijst met ondersteunde statussen.|
|userids|string/array|Retourneer alleen gebruikersgroepen die de opgegeven gebruikers bevatten.|
|usrgrpids|string/array|Retourneer alleen gebruikersgroepen met de opgegeven ID's.|
|selectTagFilters|query|Retourneer machtigingen op basis van gebruikersgroeptags in de eigenschap [tag\_filters](/manual/api/reference/usergroup/object#tag_based_permission).<br><br>Het heeft de volgende eigenschappen:<br>` groupid` - (tekenreeks) ID van de hostgroep;<br>`tag` - (tekenreeks) tagnaam;<br>`value` - (tekenreeks) tagwaarde.|
|selectUsers|query|Retourneer de gebruikers uit de gebruikersgroep in de eigenschap [users](/manual/api/reference/user/object#user).|
|selectRights|query|Retourneer gebruikersgroepsrechten in de eigenschap [rights](/manual/api/reference/usergroup/object#permission).<br><br>Het heeft de volgende eigenschappen:<br>`permission` - ( integer) toegangsniveau tot de hostgroep;<br>`id` - (tekenreeks) ID van de hostgroep.<br><br>Raadpleeg de [gebruikersgroeppagina](object#permission) voor een lijst met toegangsniveaus om groepen te hosten.|
|limitSelects|integer|Beperkt het aantal records dat wordt geretourneerd door subselects.|
|sortfield|string/array|Sorteer het resultaat op de gegeven eigenschappen.<br><br>Mogelijke waarden zijn: `usrgrpid`, `name`.|
|countOutput|boolean|Deze parameters gelden voor alle `get`-methoden en worden in detail beschreven in de [referentiecommentaar](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|booleaans|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limiet|geheel getal|^|
|uitvoer|query|^|
|preservekeys|boolean|^|
|zoeken|object|^|
|searchByAny|boolean|^|
|searchWildcardsIngeschakeld|boolean|^|
|sortorde|string/array|^|
|startZoeken|booleaans|^|

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

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

`(integer/array)` Retourneert ofwel:

- een reeks objecten;
- het aantal opgehaalde objecten, als de `countOutput` parameter heeft
    gebruikt.

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

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

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

[comment]: # ({a3c99a8f-62cd5d8e})
#### Ingeschakelde gebruikersgroepen ophalen

Haal alle ingeschakelde gebruikersgroepen op.

Verzoek:

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

Antwoord:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "usrgrpid": "7",
            "name": "Zabbix administrators",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "1"
        },
        {
            "usrgrpid": "8",
            "name": "Guests",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0"
        },
        {
            "usrgrpid": "11",
            "name": "Enabled debug mode",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "1"
        },
        {
            "usrgrpid": "12",
            "name": "No access to the frontend",
            "gui_access": "2",
            "users_status": "0",
            "debug_mode": "0"
        },
        {
            "usrgrpid": "14",
            "name": "Read only",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0"
        },
        {
            "usrgrpid": "18",
            "name": "Deny",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0"
        }
    ],
    "id": 1
}
```

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

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

- [Gebruiker](/manual/api/referentie/gebruiker/object#gebruiker)

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

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

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

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