Changes for page UserManagement Cmdlets

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

From version 1.1
edited by jklein
on 2025/06/16 13:25
Change comment: There is no comment for this version
To version 2.1
edited by jklein
on 2025/07/17 08:04
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -User Cmdlets
1 +UserManagement Cmdlets
Content
... ... @@ -2,12 +2,99 @@
2 2  
3 3  = Add-AESBRole =
4 4  
5 +Dieses Cmdlet fügt eine neue Rolle mit den angegebenen Rechten hinzu.
6 +
7 +Falls ein Hauptrecht mit allen Unterrechten hinzugefügt werden soll, muss diese Schreibweise verwendet werden: "Dashboard_*" für das Hauptrecht "Dashboard" mit allen Unterrechten.
8 +
9 +(% style="width:1623.33px" %)
10 +|=Parameter |=Datentyp|=Optional|=(% style="width: 1069px;" %)Beschreibung
11 +|-ConnectionName|String|✅|(% style="width:1069px" %)Der Name der Verbindung, über die die Rolle erstellt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
12 +|-RoleName|String|❌|(% style="width:1069px" %)Name der Rolle.
13 +|-Rights|String[]|❌|(% style="width:1069px" %)Rechte für die Rolle.
14 +|-NoConfirm|SwitchParameter|✅|(% style="width:1069px" %)Beim Hinzufügen fehlender Abhängigkeitsrechte soll der Benutzer nicht jedes mal bestätigen müssen.
15 +
16 +=== Beispiele ===
17 +
18 +Beispiel 1: Neue Rolle erstelle
19 +
20 +{{code language="powershell"}}
21 +Add-AESBRole -RoleName "MyNewTestRole" -Rights Workflows
22 +{{/code}}
23 +
24 +Dieses Beispiel erstellt eine neue Rolle mit dem Namen "MyNewTestRole" und den Rechten für "Workflows".
25 +
26 +Beispiel 2: Neue Rolle mit mehreren Rechten erstelle
27 +
28 +{{code language="powershell"}}
29 +Add-AESBRole -RoleName "MyNewTestRole" -Rights Settings, Workflows, PackageManager
30 +{{/code}}
31 +
32 +Dieses Beispiel erstellt eine Rolle mit dem Namen "MyNewTestRole" und mehreren Rechten.
33 +Falls für die Rollenerstellung ein Abhängigkeitsrecht fehlt, wird der Benutzer gefragt, ob er das Recht noch hinzufügen möchte oder nicht.
34 +
35 +Beispiel 3: Neue Rolle mit mehreren Rechten erstellen und dem optionalen Switchparameter erstelle
36 +
37 +{{code language="powershell"}}
38 +Add-AESBRole -RoleName "MyNewTestRole" -Rights Settings, Workflows, PackageManager -NoConfirm
39 +
40 +{{/code}}
41 +
42 +Dieses Beispiel erstellt eine Rolle mit dem Namen "MyNewTestRole" mit mehreren Rechten.
43 +Falls der Rolle ein Abhängigkeitsrecht fehlen sollte, wird dieses ohne Zustimmung des Benutzers der Rolle hinzugefügt.
44 +
45 +=== Rückgabewert ===
46 +
47 +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.
48 +
5 5  = Get-AESBRole =
6 6  
51 +Dieses Cmdlet zeigt für eine Rolle die Rechte-Hierarchie und die zugeordneten Benutzer an.
52 +
53 +(% style="width:1952.33px" %)
54 +|=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
55 +|-ConnectionName|String|✅|Der Name der Verbindung, über die die Informationen zur Rolle abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
56 +|-RoleId|String|❌|Die eindeutige ID der Rolle, für die die Benutzer- und Rechte-Hierarchie angezeigt werden soll.
57 +
58 +=== Beispiele ===
59 +
60 +Beispiel 1: Aufruf mit direkter Übergabe der RoleId
61 +
62 +{{code language="powershell"}}
63 +Get-AESBRole -RoleId "ffffffff-ffff-ffff-ffff-ffffffffffff"
64 +
65 +{{/code}}
66 +
67 +=== **Rückgabewert** ===
68 +
69 +Das Cmdlet gibt eine formatierte Zeichenkette mit der Hierarchie der Benutzer und Rechte der angegebenen Rolle zurück.
70 +
7 7  = Get-AESBRoleList =
8 8  
73 +Dieses Cmdlet dient dazu, eine Liste von Rollen aus dem User-Management-System abzurufen und als PowerShell-Objekte auszugeben.
74 +
75 +(% style="width:1952.33px" %)
76 +|=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
77 +|-ConnectionName|String|✅|Der Name der Verbindung, über die die Informationen zur Rolle abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
78 +|-RoleId|String|❌|Die eindeutige ID der Rolle, für die die Benutzer- und Rechte-Hierarchie angezeigt werden soll.
79 +
80 +=== Beispiele ===
81 +
82 +{{code language="powershell"}}
83 +Get-AESBRoleList
84 +{{/code}}
85 +
86 +=== Rückgabewert ===
87 +
88 +Gibt eine Liste von Rollen als PowerShell-Objekte zurück.
89 +
9 9  = Add-AESBUser =
10 10  
92 +Dieses Cmdlet dient dazu, einen neuen Benutzer anzulegen.
93 +
94 +
95 +
96 +
97 +
11 11  = Edit-AESBUser =
12 12  
13 13  = Get-AESBUsers =
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community