usergroup.delete

Beschreibung

object usergroup.delete(array userGroupIds)

Mit dieser Methode können Sie Benutzergruppen löschen.

Die Gruppe Deprovisioned users (die in Authentication für disabled_usrgrpid angegebene Benutzergruppe) kann nicht gelöscht 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 widerrufen werden. Weitere Informationen finden Sie unter User roles.

Parameter

(array) IDs der zu löschenden Benutzergruppen.

Rückgabewerte

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

Beispiele

Mehrere Benutzergruppen löschen

Löschen Sie zwei Benutzergruppen.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "usergroup.delete",
    "params": [
        "20",
        "21"
    ],
    "id": 1
}

Antwort:

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

Quelle

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