usergroup.create

Beschreibung

object usergroup.create(object/array userGroups)

Diese Methode ermöglicht es Ihnen, neue Benutzergruppen zu erstellen.

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) Benutzergruppen, die erstellt werden sollen.

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

Parameter Type Beschreibung
hostgroup_rights object/array Dem Benutzergruppe zuzuweisende Berechtigungen für Hostgruppen.
proxies object/array Proxies, die mit der Benutzergruppe verknüpft werden sollen.
Die Proxies dürfen nur die Eigenschaft proxyid definiert haben.
proxy_groups object/array Proxygruppen, die mit der Benutzergruppe verknüpft werden sollen.
Die Proxygruppen dürfen nur die Eigenschaft proxy_groupid definiert haben.
templategroup_rights object/array Der Benutzergruppe zuzuweisende Berechtigungen für Vorlagengruppen.
tag_filters array Der Benutzergruppe zuzuweisende tagbasierte Berechtigungen.
users object/array Benutzer, die der Benutzergruppe hinzugefügt werden sollen.

Der Benutzer darf nur die Eigenschaft userid definiert haben.

Rückgabewerte

(object) Gibt ein Objekt zurück, das die IDs der erstellten Benutzergruppen in der Eigenschaft usrgrpids enthält. Die Reihenfolge der zurückgegebenen IDs entspricht der Reihenfolge der übergebenen Benutzergruppen.

Beispiele

Erstellen einer Benutzergruppe

Erstellen Sie eine Benutzergruppe Operation managers mit verweigertem Zugriff auf die Host-Gruppe „2“ und fügen Sie ihr einen Benutzer hinzu.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "usergroup.create",
    "params": {
        "name": "Operation managers",
        "hostgroup_rights": {
            "id": "2",
            "permission": 0
        },
        "users": [
            {
                "userid": "12"
            }
        ]
    },
    "id": 1
}

Antwort:

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

Siehe auch

Quelle

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