usergroup.create

Beschreibung

object usergroup.create(object/array userGroups)

Diese Methode ermöglicht das Erstellen neuer Benutzergruppen.

Diese Methode ist nur für den Benutzertyp Super admin 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/array) Zu erstellende Benutzergruppen.

Zusätzlich zu den standardmäßigen Eigenschaften der Benutzergruppe akzeptiert die Methode die folgenden Parameter.

Parameter Typ Beschreibung
hostgroup_rights object/array Hostgruppen-Berechtigungen, die der Benutzergruppe zugewiesen werden sollen.
templategroup_rights object/array Vorlagengruppen-Berechtigungen, die der Benutzergruppe zugewiesen werden sollen.
tag_filters array Tag-basierte Berechtigungen, die der Benutzergruppe zugewiesen werden sollen.
users object/array Benutzer, die der Benutzergruppe hinzugefügt werden 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 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.