Wiki-Quellcode von UserManagement Cmdlets

Zuletzt geändert von jklein am 2025/08/13 11:41

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