Changes for page UserManagement Cmdlets

Last modified by jklein on 2025/08/13 11:41

From 3.1 to 2.2

From version 2.2

edited by jklein
on 2025/07/17 08:41

Change comment: There is no comment for this version

To version 1.1

edited by jklein
on 2025/06/16 13:25

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--UserManagement Cmdlets
++User Cmdlets

Content

@@ -2,159 +2,14 @@
  = Add-AESBRole =
--Dieses Cmdlet fügt eine neue Rolle mit den angegebenen Rechten hinzu.
--
--Falls ein Hauptrecht mit allen Unterrechten hinzugefügt werden soll, muss diese Schreibweise verwendet werden: "Dashboard_*" für das Hauptrecht "Dashboard" mit allen Unterrechten.
--
--(% style="width:1623.33px" %)
--|=Parameter |=Datentyp|=Optional|=(% style="width: 1069px;" %)Beschreibung
--|-ConnectionName|String|✅|(% style="width:1069px" %)Der Name der Verbindung, über die die Rolle erstellt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-RoleName|String|❌|(% style="width:1069px" %)Name der Rolle.
--|-Rights|String[]|❌|(% style="width:1069px" %)Rechte für die Rolle.
--|-NoConfirm|SwitchParameter|✅|(% style="width:1069px" %)Beim Hinzufügen fehlender Abhängigkeitsrechte soll der Benutzer nicht jedes mal bestätigen müssen.
--
--=== Beispiele ===
--
--Beispiel 1: Neue Rolle erstelle
--
--{{code language="powershell"}}
--Add-AESBRole -RoleName "MyNewTestRole" -Rights Workflows
--{{/code}}
--
--Dieses Beispiel erstellt eine neue Rolle mit dem Namen "MyNewTestRole" und den Rechten für "Workflows".
--
--Beispiel 2: Neue Rolle mit mehreren Rechten erstelle
--
--{{code language="powershell"}}
--Add-AESBRole -RoleName "MyNewTestRole" -Rights Settings, Workflows, PackageManager
--{{/code}}
--
--Dieses Beispiel erstellt eine Rolle mit dem Namen "MyNewTestRole" und mehreren Rechten.
--Falls für die Rollenerstellung ein Abhängigkeitsrecht fehlt, wird der Benutzer gefragt, ob er das Recht noch hinzufügen möchte oder nicht.
--
--Beispiel 3: Neue Rolle mit mehreren Rechten erstellen und dem optionalen Switchparameter erstelle
--
--{{code language="powershell"}}
--Add-AESBRole -RoleName "MyNewTestRole" -Rights Settings, Workflows, PackageManager -NoConfirm
--
--{{/code}}
--
--Dieses Beispiel erstellt eine Rolle mit dem Namen "MyNewTestRole" mit mehreren Rechten.
--Falls der Rolle ein Abhängigkeitsrecht fehlen sollte, wird dieses ohne Zustimmung des Benutzers der Rolle hinzugefügt.
--
--=== Rückgabewert ===
--
--Das Cmdlet Add-Role liefert als Ergebnis ein Objekt vom Typ AddRoleResultMessage, dessen Eigenschaft //Result //den Status der Rollenanlage als Wert des Enums AddRoleResult (z. B. Success, NameNotValid, NameNotUnique, Unknown, RoleIsSystemRole, RoleIsPluginRole) enthält.
--
  = Get-AESBRole =
--Dieses Cmdlet zeigt für eine Rolle die Rechte-Hierarchie und die zugeordneten Benutzer an.
--
--(% style="width:1952.33px" %)
--|=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
--|-ConnectionName|String|✅|Der Name der Verbindung, über die die Informationen zur Rolle abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-RoleId|String|❌|Die eindeutige ID der Rolle, für die die Benutzer- und Rechte-Hierarchie angezeigt werden soll.
--
--=== Beispiele ===
--
--Beispiel 1: Aufruf mit direkter Übergabe der RoleId
--
--{{code language="powershell"}}
--Get-AESBRole -RoleId "ffffffff-ffff-ffff-ffff-ffffffffffff"
--
--{{/code}}
--
--=== **Rückgabewert** ===
--
--Das Cmdlet gibt eine formatierte Zeichenkette mit der Hierarchie der Benutzer und Rechte der angegebenen Rolle zurück.
--
  = Get-AESBRoleList =
--Dieses Cmdlet dient dazu, eine Liste von Rollen aus dem User-Management-System abzurufen und als PowerShell-Objekte auszugeben.
--
--(% style="width:1952.33px" %)
--|=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
--|-ConnectionName|String|✅|Der Name der Verbindung, über die die Informationen zur Rolle abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-RoleId|String|❌|Die eindeutige ID der Rolle, für die die Benutzer- und Rechte-Hierarchie angezeigt werden soll.
--
--=== Beispiele ===
--
--{{code language="powershell"}}
--Get-AESBRoleList
--{{/code}}
--
--=== Rückgabewert ===
--
--Gibt eine Liste von Rollen als PowerShell-Objekte zurück.
--
  = Add-AESBUser =
--Dieses Cmdlet dient dazu, einen neuen Benutzer anzulegen.
--
--(% style="width:1952.33px" %)
--|=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
--|-ConnectionName|String|✅|Der Name der Verbindung, über die der Benutzer angelegt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-UserName|String|❌|Name des neuen Users.
--|-Password|SecureString|❌|Passwort des neuen Users.
--|-FirstName|String|✅|Vorname des neuen Users.
--|-LastName|String|✅|Nachname des neuen Users.
--|-IsEnabled|Bool|✅|Der neuangelegte Benutzer kann über diesen Parameter aktiviert oder deaktiviert werden. Default ist der User ist aktiviert.
--|-Roles|String[]|✅|Rechte die dem neuen Benutzer zugewiesen werden können.
--
--=== Beispiele ===
--
--Beispiel 1: Neuen Benutzer anlegen
--
--{{code language="powershell"}}
--Add-AESBUser -Username "TestUser" -Password $password
--{{/code}}
--
--Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" an.
--
--Beispiel 2: Neuen Benutzer mit weiteren Parametern anlegen
--
--{{code language="powershell"}}
--Add-AESBUser -Username "TestUser" -Password $password -FirstName "Test" -LastName "NachnameTest"
--
--{{/code}}
--
--Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" und weiteren Parametern wie FirstName und LastName an.
--
--Beispiel 3: Neuen Benutzer mit entsprechenden Rollen anlegen
--
--{{code language="powershell"}}
--Add-AESBUser -Username "TestUser" -Password $password -FirstName "Test" -LastName "NachnameTest" -Roles ReadOnly
--
--{{/code}}
--
--Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" an und weist ihm die "ReadOnly" Rolle zu.
--
--Beispiel 4: Neuen nicht aktiven Benutzer anlegen
--
--{{code language="powershell"}}
--Add-AESBUser -Username "TestUser" -Password $password -IsEnabled $false
--{{/code}}
--
--Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" aktiviert diesen aber noch nicht.
--
--=== Rückgabewert ===
--
--Objekt zur weiteren Verarbeitung mit der UserId des neu angelegten Benutzers und einer ResultInfo über das Anlegen des neuen Users.
--
  = Edit-AESBUser =
--
--
--Dieses Cmdlet dient dazu, den Vor- und/oder Nachnamen eines Benutzers anhand seiner UserId zu aktualisieren.
--
--Es unterstützt verschiedene Parametersätze, um gezielt nur den Vornamen, nur den Nachnamen oder beide zu ändern. Es ist nicht möglich, System-Benutzer (z.B. Operator) oder aus der ACMP importierte ACMP-Benutzer / AD-Benutzer zu bearbeiten.
--
--
--
--
--
--
--
  = Get-AESBUsers =
  = Remove-AESBUsers =