IPS_CreateRole

 bool IPS_CreateRole (string $Rolle) 

Parameterliste

Rückgabewert

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

Beschreibung

Die Funktion erstellt eine neue Rolle mit dem Namen Rolle. Eine neue Rolle besitzt noch keine Berechtigungen. Diese werden über IPS_AddPermissionToRole hinzugefügt. Anschließend kann die Rolle über IPS_AddRoleToUser beliebigen Benutzern zugewiesen werden, die dadurch alle Berechtigungen der Rolle erhalten. Rollen können auch über die Berechtigungssteuerung verwaltet werden.

Der Name darf nicht leer sein ("Role cannot be empty") und muss eindeutig sein, ansonsten schlägt die Funktion mit "Role with name '…' already exists" fehl. Die Groß-/Kleinschreibung wird unterschieden. Die Rolle @admin existiert immer und gewährt alle Berechtigungen.

Der ausführende Benutzer muss Administrator sein (siehe IPS_IsAdministrator), ansonsten schlägt die Funktion mit "Administrator permissions are required for this action!" fehl.

Die Rollenverwaltung steht nur mit einer Lizenz zur Verfügung, welche das RBAC-Feature enthält. Andernfalls schlägt die Funktion mit "This function is only available for licenses with the RBAC feature enabled!" fehl. Sind mehr Benutzer angelegt, als die Lizenz erlaubt, schlägt die Funktion mit "Your license is currently limited to … users. Please consider upgrading the license to more users!" fehl.

Beispiel

if (!IPS_RoleExists('Bewohner')) {
    IPS_CreateRole('Bewohner');
}

// Zugriff auf die Visualisierung mit der ID 12345 erlauben
IPS_AddPermissionToRole('Bewohner', 12345, 'VISUALIZATION', false);

// Rolle einem Benutzer zuweisen
IPS_AddRoleToUser('anna', 'Bewohner');