usergroup.update

Beschreibung

object usergroup.update(object/array userGroups)

Mit dieser Methode können vorhandene Benutzergruppen aktualisiert werden.

Diese Methode ist nur für den Benutzertyp Super admin verfügbar. Die Berechtigung zum Aufrufen der Methode kann in den Einstellungen der Benutzerrolle entzogen werden. Siehe Benutzerrollen für weitere Informationen.

Parameter

(object/array) Zu aktualisierende Eigenschaften der Benutzergruppe.

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 standardmäßigen Eigenschaften der Benutzergruppe akzeptiert die Methode die folgenden Parameter.

Parameter Typ Beschreibung
hostgroup_rights object/array Berechtigungen für Hostgruppen, die die der Benutzergruppe aktuell zugewiesenen Berechtigungen ersetzen sollen.
templategroup_rights object/array Berechtigungen für Vorlagengruppen, die die der Benutzergruppe aktuell zugewiesenen Berechtigungen ersetzen sollen.
tag_filters array Tag-basierte Berechtigungen, die die der Benutzergruppe aktuell zugewiesenen Berechtigungen ersetzen sollen.
users object/array Benutzer, die die der Benutzergruppe aktuell zugewiesenen Benutzer ersetzen sollen.

Der Benutzer darf nur die Eigenschaft userid definiert haben.
rights
(deprecated)		 object/array Dieser Parameter ist veraltet, bitte verwenden Sie stattdessen hostgroup_rights oder templategroup_rights.
Berechtigungen, die der Benutzergruppe zugewiesen werden sollen.

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.