user.delete

Beschreibung

object user.delete(array users)

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

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

(array) IDs der zu löschenden Benutzer.

Rückgabewerte

(object) Gibt ein Objekt zurück, das die IDs der gelöschten Benutzer unter der Eigenschaft userids enthält.

Beispiele

Mehrere Benutzer löschen

Löschen Sie zwei Benutzer.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "user.delete",
    "params": [
        "1",
        "5"
    ],
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": {
        "userids": [
            "1",
            "5"
        ]
    },
    "id": 1
}

Quelle

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