IPS_DeleteUser

 bool IPS_DeleteUser (string $Benutzername) 

Parameterliste

Rückgabewert

Konnte die Funktion erfolgreich ausgeführt werden, liefert sie als Ergebnis TRUE, andernfalls FALSE.

Beschreibung

Die Funktion löscht den Benutzer Benutzername mitsamt seinen Rollenzuweisungen und Berechtigungen. Die Rollen selbst bleiben erhalten.

Diese Funktion steht nur mit Lizenzen zur Verfügung, die das RBAC-Feature (Berechtigungssteuerung) enthalten. Andernfalls schlägt sie mit "This function is only available for licenses with the RBAC feature enabled!" fehl. Das Benutzerlimit der Lizenz wird hier nicht geprüft, sodass Benutzer auch dann gelöscht werden können, wenn mehr Benutzer vorhanden sind als die Lizenz erlaubt.

Der aktuell angemeldete Benutzer (siehe IPS_GetLoggedInUser) muss Administrator sein, also der Benutzer @admin oder ein Benutzer mit der Rolle @admin. Andernfalls schlägt die Funktion mit "Administrator permissions are required for this action!" fehl.

Existiert der Benutzer nicht, schlägt die Funktion mit "User with name '…' does not exist" fehl. Der Benutzer @admin kann nicht verändert werden, der Versuch schlägt mit "User @admin cannot be modified!" fehl.

Siehe auch: IPS_CreateUser, IPS_UserExists

Beispiel

if (IPS_UserExists('anna')) {
    IPS_DeleteUser('anna');
}