Wiki-Quellcode von UserManagement Cmdlets

Version 7.1 von jklein am 2025/07/24 11:31
Zeige letzte Bearbeiter
1 {{aagon.floatingbox/}}
2
3 = Add-AESBRole =
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:999px" %)
10 |=Parameter |=Datentyp|=(% style="width: 88px;" %)Optional|=(% style="width: 520px;" %)Beschreibung
11 |-ConnectionName|String|(% style="width:88px" %)✅|(% style="width:520px" %)Der Name der Verbindung, über die die Rolle erstellt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
12 |-RoleName|String|(% style="width:88px" %)❌|(% style="width:520px" %)Name der Rolle.
13 |-Rights|String[]|(% style="width:88px" %)❌|(% style="width:520px" %)Rechte für die Rolle.
14 |-NoConfirm|SwitchParameter|(% style="width:88px" %)✅|(% style="width:520px" %)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 erstellen
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 erstellen
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 erstellen
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 Recht fehlen sollte, dass eine Abhängigkeit zu den angegebenen Rechten hat und deshalb notwendig ist, 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
49 = Get-AESBRole =
50
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
71 = Get-AESBRoleList =
72
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
90 = Add-AESBUser =
91
92 Dieses Cmdlet dient dazu, einen neuen Benutzer anzulegen.
93
94 (% style="width:1952.33px" %)
95 |=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
96 |-ConnectionName|String|✅|Der Name der Verbindung, über die der Benutzer angelegt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
97 |-UserName|String|❌|Name des neuen Users.
98 |-Password|SecureString|❌|Passwort des neuen Users.
99 |-FirstName|String|✅|Vorname des neuen Users.
100 |-LastName|String|✅|Nachname des neuen Users.
101 |-IsEnabled|Bool|✅|Der neuangelegte Benutzer kann über diesen Parameter aktiviert oder deaktiviert werden. Default ist der User ist aktiviert.
102 |-Roles|String[]|✅|Rechte die dem neuen Benutzer zugewiesen werden können.
103
104 === Beispiele ===
105
106 Beispiel 1: Neuen Benutzer anlegen
107
108 {{code language="powershell"}}
109 Add-AESBUser -Username "TestUser" -Password $password
110 {{/code}}
111
112 Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" an.
113
114 Beispiel 2: Neuen Benutzer mit weiteren Parametern anlegen
115
116 {{code language="powershell"}}
117 Add-AESBUser -Username "TestUser" -Password $password -FirstName "Test" -LastName "NachnameTest"
118
119 {{/code}}
120
121 Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" und weiteren Parametern wie FirstName und LastName an.
122
123 Beispiel 3: Neuen Benutzer mit entsprechenden Rollen anlegen
124
125 {{code language="powershell"}}
126 Add-AESBUser -Username "TestUser" -Password $password -FirstName "Test" -LastName "NachnameTest" -Roles ReadOnly
127
128 {{/code}}
129
130 Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" an und weist ihm die "ReadOnly" Rolle zu.
131
132 Beispiel 4: Neuen nicht aktiven Benutzer anlegen
133
134 {{code language="powershell"}}
135 Add-AESBUser -Username "TestUser" -Password $password -IsEnabled $false
136 {{/code}}
137
138 Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" aktiviert diesen aber noch nicht.
139
140 === Rückgabewert ===
141
142 Objekt zur weiteren Verarbeitung mit der UserId des neu angelegten Benutzers und einer ResultInfo über das Anlegen des neuen Users.
143
144 = Edit-AESBUser =
145
146 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.
147
148 (% style="width:1952.33px" %)
149 |=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
150 |-ConnectionName|String|✅|Der Name der Verbindung, über die der Benutzer bearbeitet werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
151 |-UserId|String|❌|Die eindeutige Kennung des Benutzers, dessen Daten geändert werden sollen.
152 |-FirstName|String|✅❌*|Der neue Vorname des Benutzers.
153 |-LastName|String|✅❌*|Der neue Nachname des Benutzers.
154
155 {{aagon.infobox}}
156 Die mit * gekennzeichneten Parameter sind je nach Parametersatz optional oder obligatorisch.
157 {{/aagon.infobox}}
158
159 === Parametersets ===
160
161 * FirstNameOnly: Nur der Vorname wird geändert (UserId, FirstName).
162 * LastNameOnly: Nur der Nachname wird geändert (UserId, LastName).
163 * BothNames: Vor- und Nachname werden geändert (UserId, FirstName, LastName).
164
165 === Beispiele ===
166
167 Beispiel 1: FirstNameOnly: Dieser Parametersatz wird verwendet, um ausschließlich den Vornamen eines Benutzers zu ändern.
168
169 * Erforderliche Parameter: UserId, FirstName
170
171 {{code language="powershell"}}
172 Edit-AESBUser -UserId "ffffffff-ffff-ffff-ffff-ffffffffffff" -FirstName "Max"
173
174 {{/code}}
175
176 Dieser Befehl ändert den Vornamen des Benutzers mit der ID "ffffffff-ffff-ffff-ffff-ffffffffffff" zu "Max".
177
178 Beispiel 2: LastNameOnly: Dieser Parametersatz wird verwendet, um ausschließlich den Nachnamen eines Benutzers zu ändern.
179
180 * Erforderliche Parameter: UserId, LastName
181
182 {{code language="powershell"}}
183 Edit-AESBUser -UserId "ffffffff-ffff-ffff-ffff-ffffffffffff" -LastName "Mustermann"
184
185 {{/code}}
186
187 Dieser Befehl ändert den Nachnamen des Benutzers mit der ID "ffffffff-ffff-ffff-ffff-ffffffffffff" zu "Mustermann".
188
189 Beispiel 3: BothNames: Dieser Parametersatz wird verwendet, um sowohl den Vor- als auch den Nachnamen eines Benutzers gleichzeitig zu ändern.
190 Erforderliche Parameter: UserId, FirstName, LastName
191
192 {{code language="powershell"}}
193 Edit-AESBUser -UserId "benutzer123" -FirstName "Max" -LastName "Mustermann"
194 {{/code}}
195
196 Dieser Befehl ändert den Vornamen des Benutzers mit der ID "benutzer123" zu "Max" und den Nachnamen zu "Mustermann".
197
198 === Rückgabewert ===
199
200 Bei Erfolg gibt das Cmdlet ein Objekt mit den Eigenschaften UserId und Result "Success" zurück. Bei Fehlern wird eine Exception ausgelöst.
201
202 = Get-AESBUsers =
203
204 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.
205
206 (% style="width:1952.33px" %)
207 |=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
208 |-ConnectionName|String|✅|Der Name der Verbindung, über die Benutzer-Informationen abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
209 |-UserIds|String[]|❌|Eine Liste von Benutzern, deren Daten geändert werden sollen.
210
211 === Beispiele ===
212
213 Beispiel 1: Abrufen aller Benutzer
214
215 {{code language="powershell"}}
216 Get-AESBUsers
217 {{/code}}
218
219 Beispiel 2: Abrufen spezifischer Benutzer
220
221 {{code language="powershell"}}
222 Get-AESBUsers -UserIds "ffffffff-ffff-ffff-ffff-ffffffffffff", "ffffffff-ffff-ffff-ffff-ffffffffffff"
223
224 {{/code}}
225
226 === Rückgabewert ===
227
228 Das Cmdlet gibt eine Liste von UserInformation-Objekten zurück. Jedes Objekt enthält folgende Eigenschaften:
229 • UserId: Die eindeutige ID des Benutzers.
230 • Username: Der Benutzername.
231 • FirstName: Der Vorname des Benutzers.
232 • LastName: Der Nachname des Benutzers.
233 • UserStatus: Der Status des Benutzers (z. B. Aktiviert, Deaktiviert, Gesperrt).
234 • UserType: Der Typ des Benutzers (z. B. Normal, System).
235 • Roles: Eine Liste der Rollen des Benutzers.
236 • Rights: Eine Liste der Rechte des Benutzers.
237 • DomainName: Der Name der Domäne, zu der der Benutzer gehört.
238 • DomainId: Die ID der Domäne.
239 • ProcessStatus: Der Verarbeitungsstatus (z. B. Erfolgreich, Fehler).
240
241 === Fehlerbehandlung ===
242
243 • Warnungen: Wenn keine Benutzer gefunden werden, wird eine Warnung ausgegeben.
244 • Fehler: Bei schwerwiegenden Fehlern wird ein TerminatingError ausgelöst.
245
246 = Remove-AESBUsers =
247
248 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.
249
250 (% style="width:1952.33px" %)
251 |=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
252 |-ConnectionName|String|✅|Der Name der Verbindung, über die Benutzer gelöscht werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
253 |-UserIds|String[]|❌|Eine Liste von Benutzer-IDs der zu entfernenden Benutzer.
254
255 === Beispiele ===
256
257 Beispiel 1: Entfernen mehrerer Benutzer
258
259 {{code language="powershell"}}
260 Remove-AESBUsers -UserIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2", "ffffffff-ffff-ffff-ffff-fffffffffff3"
261 {{/code}}
262
263 === Rückgabewert ===
264
265 Das Cmdlet gibt eine Liste von UserDeletionResult-Objekten zurück, die die folgenden Eigenschaften enthalten:
266 • UserId: Die ID des gelöschten Benutzers.
267 • Result: Das Ergebnis der Löschung (z. B. Success, UserNotFound, SystemUser).
268
269 = Set-AESBUserIsEnabled =
270
271 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.
272
273 (% style="width:1952.33px" %)
274 |=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
275 |-ConnectionName|String|✅|Der Name der Verbindung, über die Benutzer aktiviert / deaktiviert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
276 |-UserIds|String[]|❌|Eine Liste von Benutzer-IDs, deren Status geändert werden soll.
277 |-Enable|SwitchParameter|✅❌*|Aktiviert die angegebenen Benutzer. Kann nicht zusammen mit "-Disable" verwendet werden.
278 |-Disable|SwitchParameter|✅❌*|Deaktiviert die angegebenen Benutzer. Kann nicht zusammen mit "-Enable" verwendet werden.
279
280 {{aagon.infobox}}
281 ~* Entweder Enable oder Disable ist erforderlich.
282 {{/aagon.infobox}}
283
284 === Beispiele ===
285
286 Beispiel 1: Benutzer aktivieren
287
288 {{code language="powershell" layout="LINENUMBERS"}}
289 #Einen Benutzer aktivieren
290 Set-AESBUserIsEnabled -UserIds "ffffffff-ffff-ffff-ffff-ffffffffffff" -Enable
291
292 #Mehrere Benutzer aktivieren
293 Set-AESBUserIsEnabled -UserIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2" -Enable
294 {{/code}}
295
296 Beispiel 2: Benutzer deaktivieren
297
298 {{code language="powershell" layout="LINENUMBERS"}}
299 #Einen Benutzer deaktivieren
300 Set-AESBUserIsEnabled -UserIds "ffffffff-ffff-ffff-ffff-ffffffffffff" -Disable
301
302 #Mehrere Benutzer deaktivieren
303 Set-AESBUserIsEnabled -UserIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2" -Disable
304 {{/code}}
305
306 === Rückgabewert ===
307
308 • Gibt für jeden erfolgreich verarbeiteten Benutzer ein aktualisiertes UserInfo-Objekt zurück.
309
310 = Set-AESBUserPassword =
311
312
313 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.
314
315 (% style="width:1952.33px" %)
316 |=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
317 |-ConnectionName|String|✅|Der Name der Verbindung, über die das Benutzer-Passwort geändert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
318 |-UserId|String|❌|Die Benutzer-ID des Benutzers, dessen Passwort geändert werden soll.
319 |-Password|Secure String|❌|Das neue Passwort für den Benutzer als Secure String.
320
321 === Beispiele ===
322
323 Beispiel 1: Passwort für einen Benutzer ändern
324
325 {{code language="powershell"}}
326 Set-UserPassword -UserId "ffffffff-ffff-ffff-ffff-ffffffffffff" -Password (ConvertTo-SecureString "NeuesPasswort123!" -AsPlainText -Force)
327
328 {{/code}}
329
330 === Rückgabewert ===
331
332 • Bei erfolgreicher Änderung: Ein anonymes Objekt mit UserId und Status = "Success".
333 • Bei Fehlern: PowerShell-Fehlerausgabe mit passender Fehlermeldung.
334
335 = Set-AESBUserRoles =
336
337
338 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.
339
340
341 (% style="width:1952.33px" %)
342 |=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
343 |-ConnectionName|String|✅|Der Name der Verbindung, über die die Rollen des Benutzers geändert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
344 |-UserId|String|❌|Die Benutzer-ID des Benutzers, dessen Passwort geändert werden soll.
345 |-Roles|List<RoleInfo>|❌|Die Liste der zuzuweisenden Rollen. Kann leer sein, um alle Rollen zu entfernen. 
346
347 === Beispiele ===
348
349 Beispiel 1: Rollen für einen Benutzer setzen
350
351 {{code language="powershell"}}
352 Set-AESBUserRoles -UserId "ffffffff-ffff-ffff-ffff-ffffffffffff" -Roles $rollenListe
353
354 {{/code}}
355
356 Beispiel 2: Alle Rollen eines Benutzers entfernen
357
358 {{code language="powershell"}}
359 Set-AESBUserRoles -UserId "ffffffff-ffff-ffff-ffff-ffffffffffff" -Roles @()
360 {{/code}}
361
362 === Rückgabewert ===
363
364 • Gibt für jeden erfolgreich verarbeiteten Benutzer die zugewiesenen Rollen (RoleInfo-Objekte) zurück.
365 • Gibt ein Platzhalterobjekt zurück, wenn keine Rollen zugewiesen wurden.
366
367
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community