IPS_SetUserActive

 bool IPS_SetUserActive (string $Benutzername, bool $Aktiv) 

Parameterliste

Rückgabewert

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

Beschreibung

Die Funktion aktiviert bzw. deaktiviert den Benutzer Benutzername. Nur aktive Benutzer können sich anmelden. So kann ein Benutzer vorübergehend gesperrt werden, ohne ihn zu löschen. Neu erstellte Benutzer sind zunächst deaktiviert (siehe IPS_CreateUser). Rollen und Berechtigungen des Benutzers bleiben beim Deaktivieren 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. Sind mehr Benutzer vorhanden als die Lizenz erlaubt (standardmäßig 10 Benutzer, der Benutzer @admin zählt nicht mit), schlägt sie mit "Your license is currently limited to 10 users. Please consider upgrading the license to more users!" fehl (die Zahl entspricht dem Limit der Lizenz).

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.

Beispiel

IPS_SetUserActive('anna', true);  // Aktiviert den Benutzer