usergroup.update

Beschreibung

object usergroup.update(object/array userGroups)

Diese Methode ermöglicht es Ihnen, vorhandene Benutzergruppen zu aktualisieren.

Diese Methode ist nur für den Benutzertyp Super admin verfügbar. Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle widerrufen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object/array) Eigenschaften der Benutzergruppe, die aktualisiert werden sollen.

Die Eigenschaft usrgrpid muss für jede Benutzergruppe definiert sein. Alle anderen Eigenschaften sind optional. Nur die übergebenen Eigenschaften werden aktualisiert; alle anderen bleiben unverändert.

Zusätzlich zu den Standardeigenschaften von Benutzergruppen akzeptiert die Methode die folgenden Parameter.

Parameter Type Beschreibung
hostgroup_rights object/array Berechtigungen für Hostgruppen, die die aktuell der Benutzergruppe zugewiesenen Berechtigungen ersetzen.
proxies object/array Proxies, die mit der Benutzergruppe verknüpft werden sollen.
Für die Proxies darf nur die Eigenschaft proxyid definiert sein.
proxy_groups object/array Proxygruppen, die mit der Benutzergruppe verknüpft werden sollen.
Für die Proxygruppen darf nur die Eigenschaft proxy_groupid definiert sein.
templategroup_rights object/array Berechtigungen für Vorlagengruppen, die die aktuell der Benutzergruppe zugewiesenen Berechtigungen ersetzen.
tag_filters array Tagbasierte Berechtigungen, die die aktuell der Benutzergruppe zugewiesenen Berechtigungen ersetzen.
apm_filters object/array APM-basierte Berechtigungen, die die aktuell der Benutzergruppe zugewiesenen Berechtigungen ersetzen.
users object/array Benutzer, die die aktuell der Benutzergruppe zugewiesenen Benutzer ersetzen.

Für den Benutzer darf nur die Eigenschaft userid definiert sein.

Rückgabewerte

(object) Gibt ein Objekt zurück, das die IDs der aktualisierten Benutzergruppen in der Eigenschaft usrgrpids enthält.

Beispiele

Aktivieren einer Benutzergruppe und Aktualisieren von Berechtigungen

Aktivieren Sie eine Benutzergruppe und gewähren Sie ihr Lese-/Schreibzugriff auf die Host-Gruppen „2“ und „4“.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "usergroup.update",
    "params": {
        "usrgrpid": "17",
        "users_status": "0",
        "hostgroup_rights": [
            {
                "id": "2",
                "permission": 3
            },
            {
                "id": "4",
                "permission": 3
            }
        ]
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": {
        "usrgrpids": [
            "17"
        ]
    },
    "id": 1
}

Siehe auch

Quelle

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