[comment]: # translation:outdated

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

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

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

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

Mit dieser Methode können Benutzergruppen entsprechend den angegebenen
Parametern abgerufen werden.

::: noteclassic
Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigungen
zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter [Benutzerrollen](/manual/web_interface/frontend_sections/users/user_roles).
:::

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

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

`(object)` Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Beschreibung|
|--|--|------|
|mfaids|ID/array|Gibt nur Benutzergruppen mit den angegebenen MFA-Methoden zurück.<br><br>[Parameterverhalten](/manual/api/reference_commentary#parameter-behavior):<br>- *unterstützt* für Benutzer vom Typ *Super admin*|
|mfa_status|integer|Gibt nur Benutzergruppen mit dem angegebenen MFA-Status zurück.<br><br>Eine Liste der unterstützten Status finden Sie auf der Seite [Benutzergruppe](object#user-group).|
|status|integer|Gibt nur Benutzergruppen mit dem angegebenen Status zurück.<br><br>Eine Liste der unterstützten Status finden Sie auf der Seite [Benutzergruppe](object#user-group).|
|userids|ID/array|Gibt nur Benutzergruppen zurück, die die angegebenen Benutzer enthalten.|
|usrgrpids|ID/array|Gibt nur Benutzergruppen mit den angegebenen IDs zurück.|
|selectTagFilters|query|Gibt tagbasierte Berechtigungen der Benutzergruppe in der Eigenschaft [`tag_filters`](/manual/api/reference/usergroup/object#tag-based-permission) zurück.|
|selectUsers|query|Gibt die Benutzer aus der Benutzergruppe in der Eigenschaft [`users`](/manual/api/reference/user/object#user) zurück.<br><br>Siehe [`user.get`](/manual/api/reference/user/get) für Einschränkungen basierend auf dem Benutzertyp.|
|selectHostGroupRights|query|Gibt [Berechtigungen](/manual/api/reference/usergroup/object#permission) der Host-Gruppe der Benutzergruppe in der Eigenschaft `hostgroup_rights` zurück.<br><br>Eine Liste der Zugriffsebenen auf Host-Gruppen finden Sie auf der Seite [Benutzergruppe](object#permission).|
|selectTemplateGroupRights|query|Gibt [Berechtigungen](/manual/api/reference/usergroup/object#permission) der Vorlagengruppe der Benutzergruppe in der Eigenschaft `templategroup_rights` zurück.<br><br>Eine Liste der Zugriffsebenen auf Vorlagengruppen finden Sie auf der Seite [Benutzergruppe](object#permission).|
|limitSelects|integer|Begrenzt die Anzahl der von Unterabfragen zurückgegebenen Datensätze.|
|output|query|Eigenschaften des [Benutzergruppenobjekts](/manual/api/reference/usergroup/object), die zurückgegeben werden sollen.<br><br>Benutzer vom Typ *Admin* und *User* können nur die folgenden Eigenschaften abrufen: `usrgrpid`, `name`, `gui_access`, `users_status`, `debug_mode`, `mfa_status`.<br><br>Standard: `extend`.|
|sortfield|string/array|Sortiert das Ergebnis nach den angegebenen Eigenschaften.<br><br>Mögliche Werte: `usrgrpid`, `name`.|
|countOutput|boolean|Diese Parameter sind in der [Referenzkommentierung](/manual/api/reference_commentary#common-get-method-parameters) beschrieben.|
|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})
### Rückgabewerte

`(integer/array)` Gibt entweder Folgendes zurück:

-   ein Array von Objekten;
-   die Anzahl der abgerufenen Objekte, wenn der Parameter `countOutput` verwendet wurde.

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

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

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

[comment]: # ({e685bea9-62cd5d8e})
#### Aktivierte Benutzergruppen abrufen

Rufen Sie alle aktivierten Benutzergruppen ab.

[Anfrage](/manual/api#performing-requests):

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

Antwort:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "usrgrpid": "7",
            "name": "Zabbix-Administratoren",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "1",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "8",
            "name": "Gäste",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "11",
            "name": "Debug-Modus aktiviert",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "1",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "12",
            "name": "Kein Zugriff auf das Frontend",
            "gui_access": "2",
            "users_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "14",
            "name": "Schreibgeschützt",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "18",
            "name": "Verweigern",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        }
    ],
    "id": 1
}
```

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

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

-   [User](/manual/api/reference/user/object#user)

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

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

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

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