usergroup.get

Beschreibung

integer/array usergroup.get(object parameters)

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

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.

Parameter

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

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
mfaids ID/array Gibt nur Benutzergruppen mit den angegebenen MFA-Methoden zurück.

Parameterverhalten:
- unterstützt für Benutzer vom Typ Super admin (seit Zabbix 7.0.9)
mfa_status integer Gibt nur Benutzergruppen mit dem angegebenen MFA-Status zurück.

Eine Liste der unterstützten Status finden Sie auf der Benutzergruppen-Seite.
status integer Gibt nur Benutzergruppen mit dem angegebenen Status zurück.

Eine Liste der unterstützten Status finden Sie auf der Benutzergruppen-Seite.
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 die auf Benutzergruppen-Tags basierenden Berechtigungen in der Eigenschaft tag_filters zurück.
selectUsers query Gibt die Benutzer aus der Benutzergruppe in der Eigenschaft users zurück.

Siehe user.get für Einschränkungen basierend auf dem Benutzertyp.
selectHostGroupRights query Gibt die Berechtigungen der Benutzergruppe für Hostgruppen in der Eigenschaft hostgroup_rights zurück.

Eine Liste der Zugriffsebenen für Hostgruppen finden Sie auf der Benutzergruppen-Seite.
selectTemplateGroupRights query Gibt die Berechtigungen der Benutzergruppe für Vorlagengruppen in der Eigenschaft templategroup_rights zurück.

Eine Liste der Zugriffsebenen für Vorlagengruppen finden Sie auf der Benutzergruppen-Seite.
limitSelects integer Begrenzt die Anzahl der von Unterabfragen zurückgegebenen Datensätze.
output query Zurückzugebende Eigenschaften des Benutzergruppen-Objekts.

Seit Zabbix 7.0.9 können Benutzer vom Typ Admin und User nur die folgenden Eigenschaften abrufen: usrgrpid, name, gui_access, users_status, debug_mode, mfa_status.

Standard: extend.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: usrgrpid, name.
countOutput boolean Diese Parameter werden in der Referenzdokumentation beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectRights
(deprecated)		 query Dieser Parameter ist veraltet, bitte verwenden Sie stattdessen selectHostGroupRights oder selectTemplateGroupRights.
Gibt die Rechte der Benutzergruppe in der Eigenschaft rights zurück.
Eine Liste der Zugriffsebenen für Hostgruppen finden Sie auf der Benutzergruppen-Seite.

Rückgabewerte

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

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

Beispiele

Aktivierte Benutzergruppen abrufen

Rufen Sie alle aktivierten Benutzergruppen ab.

Anfrage:

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

Antwort:

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

Siehe auch

Quelle

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