Wiki source code of UserManagement Cmdlets

Version 10.1 by jklein on 2025/08/13 11:41
Show last authors
1 {{aagon.floatingbox/}}
2
3 = Add-AESBRole =
4
5 Dieses Cmdlet fügt eine neue Rolle mit den angegebenen Rechten hinzu.
6
7 (% style="width:999px" %)
8 |=Parameter |=Datentyp|=Erforderlich|=(% style="width: 520px;" %)Beschreibung
9 |-ConnectionName|String|❌|(% style="width:520px" %)Der Name der Verbindung, über die die Rolle erstellt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
10 |-RoleName|String|✅|(% style="width:520px" %)Name der Rolle.
11 |-Rights|String[]|(% style="width:88px" %)✅|(% style="width:520px" %)Rechte für die Rolle.
12 |-NoConfirm|SwitchParameter|(% style="width:88px" %)❌|(% style="width:520px" %)Beim Hinzufügen fehlender Abhängigkeitsrechte soll der Benutzer nicht jedes mal bestätigen müssen.
13
14 {{aagon.infobox}}
15 Wenn ein Hauptrecht mit allen Unterrechten hinzugefügt werden soll, muss folgende Schreibweise verwendet werden: "Dashboard_*" für das Hauptrecht "Dashboard" mit allen Unterrechten.
16 {{/aagon.infobox}}
17
18 {{aagon.warnungsbox}}
19 Falls bei der Ausführung des Cmdlets für die Rollenerstellung ein Abhängigkeitsrecht fehlt, werden Sie gefragt, ob Sie das Recht hinzufügen möchten oder nicht. Wenn Sie dies ablehnen, wird die Rolle nicht erstellt!
20 {{/aagon.warnungsbox}}
21
22 (% class="box warningmessage" %)
23 (((
24 [[image:https://doc.aagon.com/bin/download/XWiki/Aagon%20Warnungsbox/WebHome/Warning.svg||alt="Warning" height="32" width="32"]] **Achtung: **
25
26 Falls bei der Ausführung des Cmdlets für die Rollenerstellung ein Abhängigkeitsrecht fehlt, werden Sie gefragt, ob Sie das Recht hinzufügen möchten oder nicht. Wenn Sie dies ablehnen, wird die Rolle nicht erstellt!
27 )))
28
29
30 === Beispiele ===
31
32 Beispiel 1: Neue Rolle erstellen
33
34 {{code language="powershell"}}
35 Add-AESBRole -RoleName "MyNewTestRole" -Rights Workflows
36 {{/code}}
37
38 Dieses Beispiel erstellt eine neue Rolle mit dem Namen "MyNewTestRole" und den Rechten für "Workflows".
39
40 Beispiel 2: Neue Rolle mit mehreren Rechten erstellen
41
42 {{code language="powershell"}}
43 Add-AESBRole -RoleName "MyNewTestRole" -Rights Settings, Workflows, PackageManager
44 {{/code}}
45
46 Dieses Beispiel erstellt eine Rolle mit dem Namen "MyNewTestRole" und mehreren Rechten.
47
48 Beispiel 3: Neue Rolle mit mehreren Rechten erstellen und dem optionalen Switchparameter erstellen
49
50 {{code language="powershell"}}
51 Add-AESBRole -RoleName "MyNewTestRole" -Rights Settings, Workflows, PackageManager -NoConfirm
52
53 {{/code}}
54
55 Dieses Beispiel erstellt eine Rolle mit dem Namen "MyNewTestRole" mit mehreren Rechten.
56 Durch den Parameter {{code language="none"}}-NoConfirm{{/code}} werden notwendige, aber fehlende Abhängigkeitsrechte ohne Zustimmung des Benutzers zur Rolle hinzugefügt.
57
58 === Rückgabewert ===
59
60 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.
61
62 = Get-AESBRole =
63
64 Dieses Cmdlet zeigt für eine Rolle die Rechte-Hierarchie und die zugeordneten Benutzer an.
65
66 (% style="width:1952.33px" %)
67 |=Parameter |=Datentyp|=Erforderlich|=(% style="width: 1397px;" %)Beschreibung
68 |-ConnectionName|String|❌|Der Name der Verbindung, über die die Informationen zur Rolle abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
69 |-RoleId|String|✅|Die eindeutige ID der Rolle, für die die Benutzer- und Rechte-Hierarchie angezeigt werden soll.
70
71 === Beispiele ===
72
73 Beispiel 1: Aufruf mit direkter Übergabe der RoleId
74
75 {{code language="powershell"}}
76 Get-AESBRole -RoleId "ffffffff-ffff-ffff-ffff-ffffffffffff"
77
78 {{/code}}
79
80 === **Rückgabewert** ===
81
82 Das Cmdlet gibt eine formatierte Zeichenkette mit der Hierarchie der Benutzer und Rechte der angegebenen Rolle zurück.
83
84 = Get-AESBRoleList =
85
86 Dieses Cmdlet dient dazu, eine Liste von Rollen aus dem User-Management-System abzurufen und als PowerShell-Objekte auszugeben.
87
88 (% style="width:1952.33px" %)
89 |=Parameter |=Datentyp|=Erforderlich|=(% style="width: 1397px;" %)Beschreibung
90 |-ConnectionName|String|❌|Der Name der Verbindung, über die die Informationen zur Rolle abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
91 |-RoleId|String|✅|Die eindeutige ID der Rolle, für die die Benutzer- und Rechte-Hierarchie angezeigt werden soll.
92
93 === Beispiele ===
94
95 {{code language="powershell"}}
96 Get-AESBRoleList
97 {{/code}}
98
99 === Rückgabewert ===
100
101 Gibt eine Liste von Rollen als PowerShell-Objekte zurück.
102
103 = Add-AESBUser =
104
105 Dieses Cmdlet dient dazu, einen neuen Benutzer anzulegen.
106
107 (% style="width:1952.33px" %)
108 |=Parameter |=Datentyp|=Erforderlich|=(% style="width: 1397px;" %)Beschreibung
109 |-ConnectionName|String|❌|Der Name der Verbindung, über die der Benutzer angelegt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
110 |-UserName|String|✅|Name des neuen Users.
111 |-Password|SecureString|✅|Passwort des neuen Users.
112 |-FirstName|String|❌|Vorname des neuen Users.
113 |-LastName|String|❌|Nachname des neuen Users.
114 |-IsEnabled|Bool|❌|Der neu angelegte Benutzer kann über diesen Parameter aktiviert oder deaktiviert werden. Default ist der User ist aktiviert.
115 |-Roles|String[]|❌|Rechte die dem neuen Benutzer zugewiesen werden können.
116
117 === Beispiele ===
118
119 Beispiel 1: Neuen Benutzer anlegen
120
121 {{code language="powershell"}}
122 Add-AESBUser -Username "TestUser" -Password $password
123 {{/code}}
124
125 Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" an.
126
127 Beispiel 2: Neuen Benutzer mit weiteren Parametern anlegen
128
129 {{code language="powershell"}}
130 Add-AESBUser -Username "TestUser" -Password $password -FirstName "Test" -LastName "NachnameTest"
131
132 {{/code}}
133
134 Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" und weiteren Parametern wie FirstName und LastName an.
135
136 Beispiel 3: Neuen Benutzer mit entsprechenden Rollen anlegen
137
138 {{code language="powershell"}}
139 Add-AESBUser -Username "TestUser" -Password $password -FirstName "Test" -LastName "NachnameTest" -Roles ReadOnly
140
141 {{/code}}
142
143 Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" an und weist ihm die "ReadOnly" Rolle zu.
144
145 Beispiel 4: Neuen nicht aktiven Benutzer anlegen
146
147 {{code language="powershell"}}
148 Add-AESBUser -Username "TestUser" -Password $password -IsEnabled $false
149 {{/code}}
150
151 Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" aktiviert diesen aber noch nicht.
152
153 === Rückgabewert ===
154
155 Objekt zur weiteren Verarbeitung mit der UserId des neu angelegten Benutzers und einer ResultInfo über das Anlegen des neuen Users.
156
157 = Edit-AESBUser =
158
159 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. Mit diesem Cmdlet ist es nicht möglich, System-Benutzer (z.B. Operator) oder aus der ACMP importierte ACMP-Benutzer/AD-Benutzer zu bearbeiten.
160
161 (% style="width:1952.33px" %)
162 |=Parameter |=Datentyp|=Erforderlich|=(% style="width: 1397px;" %)Beschreibung
163 |-ConnectionName|String|❌|Der Name der Verbindung, über die der Benutzer bearbeitet werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
164 |-UserId|String|✅|Die eindeutige Kennung des Benutzers, dessen Daten geändert werden sollen.
165 |-FirstName|String|✅❌*|Der neue Vorname des Benutzers.
166 |-LastName|String|✅❌*|Der neue Nachname des Benutzers.
167
168 {{aagon.infobox}}
169 Die mit * gekennzeichneten Parameter sind je nach Parametersatz erforderlich oder optional .
170 {{/aagon.infobox}}
171
172 === Parametersets ===
173
174 * FirstNameOnly: Nur der Vorname wird geändert (UserId, FirstName).
175 * LastNameOnly: Nur der Nachname wird geändert (UserId, LastName).
176 * BothNames: Vor- und Nachname werden geändert (UserId, FirstName, LastName).
177
178 === Beispiele ===
179
180 Beispiel 1: FirstNameOnly: Dieser Parametersatz wird verwendet, um ausschließlich den Vornamen eines Benutzers zu ändern.
181
182 * Erforderliche Parameter: UserId, FirstName
183
184 {{code language="powershell"}}
185 Edit-AESBUser -UserId "ffffffff-ffff-ffff-ffff-ffffffffffff" -FirstName "Max"
186
187 {{/code}}
188
189 Dieser Befehl ändert den Vornamen des Benutzers mit der ID "ffffffff-ffff-ffff-ffff-ffffffffffff" zu "Max".
190
191 Beispiel 2: LastNameOnly: Dieser Parametersatz wird verwendet, um ausschließlich den Nachnamen eines Benutzers zu ändern.
192
193 * Erforderliche Parameter: UserId, LastName
194
195 {{code language="powershell"}}
196 Edit-AESBUser -UserId "ffffffff-ffff-ffff-ffff-ffffffffffff" -LastName "Mustermann"
197
198 {{/code}}
199
200 Dieser Befehl ändert den Nachnamen des Benutzers mit der ID "ffffffff-ffff-ffff-ffff-ffffffffffff" zu "Mustermann".
201
202 Beispiel 3: BothNames: Dieser Parametersatz wird verwendet, um sowohl den Vor- als auch den Nachnamen eines Benutzers gleichzeitig zu ändern.
203 Erforderliche Parameter: UserId, FirstName, LastName
204
205 {{code language="powershell"}}
206 Edit-AESBUser -UserId "benutzer123" -FirstName "Max" -LastName "Mustermann"
207 {{/code}}
208
209 Dieser Befehl ändert den Vornamen des Benutzers mit der ID "benutzer123" zu "Max" und den Nachnamen zu "Mustermann".
210
211 === Rückgabewert ===
212
213 Bei Erfolg gibt das Cmdlet ein Objekt mit den Eigenschaften UserId und Result "Success" zurück. Bei Fehlern wird eine Exception ausgelöst.
214
215 = Get-AESBUsers =
216
217 Dieses Cmdlet wird verwendet, um Benutzerinformationen aus einem System abzurufen. Es unterstützt die Angabe von UserIds und gibt detaillierte Informationen zu den Benutzern zurück, einschließlich Rollen, Rechte und Domäneninformationen.
218
219 (% style="width:1952.33px" %)
220 |=Parameter |=Datentyp|=Erforderlich|=(% style="width: 1397px;" %)Beschreibung
221 |-ConnectionName|String|❌|Der Name der Verbindung, über die Benutzer-Informationen abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
222 |-UserIds|String[]|✅|Eine Liste von Benutzern, deren Daten geändert werden sollen.
223
224 === Beispiele ===
225
226 Beispiel 1: Abrufen aller Benutzer
227
228 {{code language="powershell"}}
229 Get-AESBUsers
230 {{/code}}
231
232 Beispiel 2: Abrufen spezifischer Benutzer
233
234 {{code language="powershell"}}
235 Get-AESBUsers -UserIds "ffffffff-ffff-ffff-ffff-ffffffffffff", "ffffffff-ffff-ffff-ffff-ffffffffffff"
236
237 {{/code}}
238
239 === Rückgabewert ===
240
241 Das Cmdlet gibt eine Liste von UserInformation-Objekten zurück. Jedes Objekt enthält folgende Eigenschaften:
242 • UserId: Die eindeutige ID des Benutzers.
243 • Username: Der Benutzername.
244 • FirstName: Der Vorname des Benutzers.
245 • LastName: Der Nachname des Benutzers.
246 • UserStatus: Der Status des Benutzers (z. B. Aktiviert, Deaktiviert, Gesperrt).
247 • UserType: Der Typ des Benutzers (z. B. Normal, System).
248 • Roles: Eine Liste der Rollen des Benutzers.
249 • Rights: Eine Liste der Rechte des Benutzers.
250 • DomainName: Der Name der Domäne, zu der der Benutzer gehört.
251 • DomainId: Die ID der Domäne.
252 • ProcessStatus: Der Verarbeitungsstatus (z. B. Erfolgreich, Fehler).
253
254 === Fehlerbehandlung ===
255
256 • Warnungen: Wenn keine Benutzer gefunden werden, wird eine Warnung ausgegeben.
257 • Fehler: Bei schwerwiegenden Fehlern wird ein TerminatingError ausgelöst.
258
259 = Remove-AESBUsers =
260
261 Dieses Cmdlet wird verwendet, um Benutzer aus einem System zu entfernen. Es akzeptiert eine Liste von UserIds und führt die Löschung asynchron durch. Mit diesem Cmdlet ist es nicht möglich, System-Benutzer (z.B. Operator) zu entfernen.
262
263 (% style="width:1952.33px" %)
264 |=Parameter |=Datentyp|=Erforderlich|=(% style="width: 1397px;" %)Beschreibung
265 |-ConnectionName|String|❌|Der Name der Verbindung, über die Benutzer gelöscht werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
266 |-UserIds|String[]|✅|Eine Liste von Benutzer-IDs der zu entfernenden Benutzer.
267
268 === Beispiele ===
269
270 Beispiel 1: Entfernen mehrerer Benutzer
271
272 {{code language="powershell"}}
273 Remove-AESBUsers -UserIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2", "ffffffff-ffff-ffff-ffff-fffffffffff3"
274 {{/code}}
275
276 === Rückgabewert ===
277
278 Das Cmdlet gibt eine Liste von UserDeletionResult-Objekten zurück, die die folgenden Eigenschaften enthalten:
279 • UserId: Die ID des gelöschten Benutzers.
280 • Result: Das Ergebnis der Löschung (z. B. Success, UserNotFound, SystemUser).
281
282 = Set-AESBUserIsEnabled =
283
284 Dieses Cmdlet wird verwendet, um den Aktivierungsstatus von Benutzern in einem System zu ändern. Es unterstützt das Aktivieren und Deaktivieren von Benutzern basierend auf deren UserIds. Mit diesem Cmdlet ist es nicht möglich, System-Benutzer (z.B. Operator) zu aktivieren/deaktivieren.
285
286 (% style="width:1952.33px" %)
287 |=Parameter |=Datentyp|=Erforderlich|=(% style="width: 1397px;" %)Beschreibung
288 |-ConnectionName|String|❌|Der Name der Verbindung, über die Benutzer aktiviert / deaktiviert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
289 |-UserIds|String[]|✅|Eine Liste von Benutzer-IDs, deren Status geändert werden soll.
290 |-Enable|SwitchParameter|✅❌*|Aktiviert die angegebenen Benutzer. Kann nicht zusammen mit "-Disable" verwendet werden.
291 |-Disable|SwitchParameter|✅❌*|Deaktiviert die angegebenen Benutzer. Kann nicht zusammen mit "-Enable" verwendet werden.
292
293 {{aagon.infobox}}
294 ~* Entweder Enable oder Disable ist erforderlich.
295 {{/aagon.infobox}}
296
297 === Beispiele ===
298
299 Beispiel 1: Benutzer aktivieren
300
301 {{code language="powershell" layout="LINENUMBERS"}}
302 #Einen Benutzer aktivieren
303 Set-AESBUserIsEnabled -UserIds "ffffffff-ffff-ffff-ffff-ffffffffffff" -Enable
304
305 #Mehrere Benutzer aktivieren
306 Set-AESBUserIsEnabled -UserIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2" -Enable
307 {{/code}}
308
309 Beispiel 2: Benutzer deaktivieren
310
311 {{code language="powershell" layout="LINENUMBERS"}}
312 #Einen Benutzer deaktivieren
313 Set-AESBUserIsEnabled -UserIds "ffffffff-ffff-ffff-ffff-ffffffffffff" -Disable
314
315 #Mehrere Benutzer deaktivieren
316 Set-AESBUserIsEnabled -UserIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2" -Disable
317 {{/code}}
318
319 === Rückgabewert ===
320
321 • Gibt für jeden erfolgreich verarbeiteten Benutzer ein aktualisiertes UserInfo-Objekt zurück.
322
323 = Set-AESBUserPassword =
324
325
326 Dieses Cmdlet dient dazu, das Passwort eines Benutzers anhand seiner UserId zu setzen. Das Passwort eines importierten ACMP-Benutzers/AD-Benutzers kann mit diesem Cmdlet nicht geändert werden.
327
328 (% style="width:1952.33px" %)
329 |=Parameter |=Datentyp|=Erforderlich|=(% style="width: 1397px;" %)Beschreibung
330 |-ConnectionName|String|❌|Der Name der Verbindung, über die das Benutzer-Passwort geändert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
331 |-UserId|String|✅|Die Benutzer-ID des Benutzers, dessen Passwort geändert werden soll.
332 |-Password|Secure String|✅|Das neue Passwort für den Benutzer als Secure String.
333
334 === Beispiele ===
335
336 Beispiel 1: Passwort für einen Benutzer ändern
337
338 {{code language="powershell"}}
339 Set-UserPassword -UserId "ffffffff-ffff-ffff-ffff-ffffffffffff" -Password (ConvertTo-SecureString "NeuesPasswort123!" -AsPlainText -Force)
340
341 {{/code}}
342
343 === Rückgabewert ===
344
345 • Bei erfolgreicher Änderung: Ein anonymes Objekt mit UserId und Status = "Success".
346 • Bei Fehlern: PowerShell-Fehlerausgabe mit passender Fehlermeldung.
347
348 = Set-AESBUserRoles =
349
350
351 Dieses Cmdlet dient dazu, die Rollen eines Benutzers anhand seiner UserId zu setzen. Es ermöglicht das Zuweisen und Entfernen von Rollen für einen bestimmten Benutzer. Mit diesem Cmdlet ist es nicht möglich, System-Benutzern (z.B. Operator) Rollen zuzuweisen.
352
353
354 (% style="width:1952.33px" %)
355 |=Parameter |=Datentyp|=Erforderlich|=(% style="width: 1397px;" %)Beschreibung
356 |-ConnectionName|String|❌|Der Name der Verbindung, über die die Rollen des Benutzers geändert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
357 |-UserId|String|✅|Die Benutzer-ID des Benutzers, dessen Passwort geändert werden soll.
358 |-Roles|List<RoleInfo>|✅|Die Liste der zuzuweisenden Rollen. Kann leer sein, um alle Rollen zu entfernen. 
359
360 === Beispiele ===
361
362 Beispiel 1: Rollen für einen Benutzer setzen
363
364 {{code language="powershell"}}
365 Set-AESBUserRoles -UserId "ffffffff-ffff-ffff-ffff-ffffffffffff" -Roles $rollenListe
366
367 {{/code}}
368
369 Beispiel 2: Alle Rollen eines Benutzers entfernen
370
371 {{code language="powershell"}}
372 Set-AESBUserRoles -UserId "ffffffff-ffff-ffff-ffff-ffffffffffff" -Roles @()
373 {{/code}}
374
375 === Rückgabewert ===
376
377 • Gibt für jeden erfolgreich verarbeiteten Benutzer die zugewiesenen Rollen (RoleInfo-Objekte) zurück.
378 • Gibt ein Platzhalterobjekt zurück, wenn keine Rollen zugewiesen wurden.
379
380
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community