usergroup.get

Beschreibung

integer/array usergroup.get(object parameters)

Die Methode ermöglicht es Ihnen, Benutzergruppen anhand der angegebenen Parameter abzurufen.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigung zum Aufruf der Methode kann in den Einstellungen der Benutzerrolle widerrufen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

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

Die Methode unterstützt die folgenden Parameter.

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

Parameterverhalten:
- unterstützt für Benutzer des Typs Super admin
mfa_status integer Gibt nur Benutzergruppen mit dem angegebenen MFA-Status zurück.

Eine Liste der unterstützten Status finden Sie auf der Seite zu Benutzergruppen.
proxyids ID/array Gibt nur Benutzergruppen zurück, die die angegebenen Proxys enthalten.

Parameterverhalten:
- unterstützt für Benutzer des Typs Super admin.
proxy_groupids ID/array Gibt nur Benutzergruppen zurück, die die angegebenen Proxy-Gruppen enthalten.

Parameterverhalten:
- unterstützt für Benutzer des Typs Super admin.
selectProxies ID/array Gibt eine Eigenschaft proxies mit den Proxys der Benutzergruppe zurück.

Parameterverhalten:
- unterstützt für Benutzer des Typs Super admin.
selectProxyGroups ID/array Gibt eine Eigenschaft proxy_groups mit den Proxy-Gruppen der Benutzergruppe zurück.

Parameterverhalten:
- unterstützt für Benutzer des Typs Super admin.
status integer Gibt nur Benutzergruppen mit dem angegebenen Status zurück.

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

Informationen zu Einschränkungen basierend auf dem Benutzertyp finden Sie unter user.get.
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 Seite zu Benutzergruppen.
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 Seite zu Benutzergruppen.
limitSelects integer Begrenzt die Anzahl der von Unterabfragen zurückgegebenen Datensätze.
output query Zurückzugebende Eigenschaften des Benutzergruppenobjekts.

Benutzer des Typs Admin und User können 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 im Referenzkommentar beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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.