Wiki source code of UserManagement Cmdlets

Version 3.1 by jklein on 2025/07/17 09:55

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
	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
1.1	49	= Get-AESBRole =
	50
2.1	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
1.1	71	= Get-AESBRoleList =
	72
2.1	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
1.1	90	= Add-AESBUser =
	91
2.1	92	Dieses Cmdlet dient dazu, einen neuen Benutzer anzulegen.
	93
2.2	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.
2.1	103
2.2	104	=== Beispiele ===
2.1	105
2.2	106	Beispiel 1: Neuen Benutzer anlegen
2.1	107
2.2	108	{{code language="powershell"}}
	109	Add-AESBUser -Username "TestUser" -Password $password
	110	{{/code}}
2.1	111
2.2	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
1.1	144	= Edit-AESBUser =
	145
3.1	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. Es ist nicht möglich, System-Benutzer (z.B. Operator) oder aus der ACMP importierte ACMP-Benutzer / AD-Benutzer zu bearbeiten.
2.2	147
3.1	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.
2.2	154
3.1	155	{{aagon.infobox}}
	156	Die mit * gekennzeichneten Parameter sind je nach Parametersatz optional oder obligatorisch.
	157	{{/aagon.infobox}}
2.2	158
3.1	159	(% class="box infomessage" %)
	160	(((
	161	[[image:https://doc.aagon.com/bin/download/XWiki/Aagon Infobox/WebHome/Information.svg\|\|alt="Hinweis" height="32" width="32"]] Hinweis:
2.2	162
3.1	163	Die mit * gekennzeichneten Parameter sind je nach Parametersatz optional oder obligatorisch.
	164	)))
2.2	165
3.1	166	Parametersets
2.2	167
3.1	168	* FirstNameOnly: Nur der Vorname wird geändert (UserId, FirstName).
	169	* LastNameOnly: Nur der Nachname wird geändert (UserId, LastName).
	170	* BothNames: Vor- und Nachname werden geändert (UserId, FirstName, LastName).
2.2	171
3.1	172	=== Beispiele ===
2.2	173
3.1	174	Beispiel 1: FirstNameOnly: Dieser Parametersatz wird verwendet, um ausschließlich den Vornamen eines Benutzers zu ändern.
2.2	175
3.1	176	* Erforderliche Parameter: UserId, FirstName
2.2	177
3.1	178	{{code language="powershell"}}
	179	Edit-AESBUser -UserId "benutzer123" -FirstName "Max"
	180
	181	{{/code}}
	182
	183	Dieser Befehl ändert den Vornamen des Benutzers mit der ID "benutzer123" zu "Max".
	184
	185	Beispiel 2: LastNameOnly: Dieser Parametersatz wird verwendet, um ausschließlich den Nachnamen eines Benutzers zu ändern.
	186
	187	* Erforderliche Parameter: UserId, LastName
	188
	189	{{code language="powershell"}}
	190	Edit-AESBUser -UserId "benutzer123" -LastName "Mustermann"
	191
	192	{{/code}}
	193
	194	Dieser Befehl ändert den Nachnamen des Benutzers mit der ID "benutzer123" zu "Mustermann".
	195
	196	Beispiel 3: BothNames: Dieser Parametersatz wird verwendet, um sowohl den Vor- als auch den Nachnamen eines Benutzers gleichzeitig zu ändern.
	197	Erforderliche Parameter: UserId, FirstName, LastName
	198
	199	{{code language="powershell"}}
	200	Edit-AESBUser -UserId "benutzer123" -FirstName "Max" -LastName "Mustermann"
	201	{{/code}}
	202
	203	Dieser Befehl ändert den Vornamen des Benutzers mit der ID "benutzer123" zu "Max" und den Nachnamen zu "Mustermann".
	204
	205	=== Rückgabewert ===
	206
	207	Bei Erfolg gibt das Cmdlet ein Objekt mit den Eigenschaften UserId und Result "Success" zurück. Bei Fehlern wird eine Exception ausgelöst.
	208
1.1	209	= Get-AESBUsers =
	210
3.1	211	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.
	212
	213	(% style="width:1952.33px" %)
	214	\|=Parameter \|=Datentyp\|=Optional\|=(% style="width: 1397px;" %)Beschreibung
	215	\|-ConnectionName\|String\|✅\|Der Name der Verbindung, über die Benutzer-Informationen abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
	216	\|-UserIds\|String[]\|❌\|Eine Liste von Benutzern, deren Daten geändert werden sollen.
	217
	218	=== Beispiele ===
	219
	220	Beispiel 1: Abrufen aller Benutzer
	221
	222	{{code language="powershell"}}
	223	Get-AESBUsers
	224	{{/code}}
	225
	226	Beispiel 2: Abrufen spezifischer Benutzer
	227
	228	{{code language="powershell"}}
	229	Get-AESBUsers -UserIds "ffffffff-ffff-ffff-ffff-ffffffffffff", "ffffffff-ffff-ffff-ffff-ffffffffffff"
	230
	231	{{/code}}
	232
	233	=== Rückgabewert ===
	234
	235	Das Cmdlet gibt eine Liste von UserInformation-Objekten zurück. Jedes Objekt enthält folgende Eigenschaften:
	236	• UserId: Die eindeutige ID des Benutzers.
	237	• Username: Der Benutzername.
	238	• FirstName: Der Vorname des Benutzers.
	239	• LastName: Der Nachname des Benutzers.
	240	• UserStatus: Der Status des Benutzers (z. B. Aktiviert, Deaktiviert, Gesperrt).
	241	• UserType: Der Typ des Benutzers (z. B. Normal, System).
	242	• Roles: Eine Liste der Rollen des Benutzers.
	243	• Rights: Eine Liste der Rechte des Benutzers.
	244	• DomainName: Der Name der Domäne, zu der der Benutzer gehört.
	245	• DomainId: Die ID der Domäne.
	246	• ProcessStatus: Der Verarbeitungsstatus (z. B. Erfolgreich, Fehler).
	247
	248	=== Fehlerbehandlung ===
	249
	250	• Warnungen: Wenn keine Benutzer gefunden werden, wird eine Warnung ausgegeben.
	251	• Fehler: Bei schwerwiegenden Fehlern wird ein TerminatingError ausgelöst.
	252
1.1	253	= Remove-AESBUsers =
	254
3.1	255	Dieses Cmdlet wird verwendet, um Benutzer aus einem System zu entfernen. Es akzeptiert eine Liste von Benutzer-IDs und führt die Löschung asynchron durch. Es ist nicht möglich, System-Benutzer (z.B. Operator) zu entfernen.
	256
	257	(% style="width:1952.33px" %)
	258	\|=Parameter \|=Datentyp\|=Optional\|=(% style="width: 1397px;" %)Beschreibung
	259	\|-ConnectionName\|String\|✅\|Der Name der Verbindung, über die Benutzer gelöscht werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
	260	\|-UserIds\|String[]\|❌\|Eine Liste von Benutzer-IDs der zu entfernenden Benutzer.
	261
	262	=== Beispiele ===
	263
	264	Beispiel 1: Entfernen mehrerer Benutzer
	265
	266	{{code language="powershell"}}
	267	Remove-AESBUsers -UserIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2", "ffffffff-ffff-ffff-ffff-fffffffffff3"
	268	{{/code}}
	269
	270	=== Rückgabewert ===
	271
	272	Das Cmdlet gibt eine Liste von UserDeletionResult-Objekten zurück, die die folgenden Eigenschaften enthalten:
	273	• UserId: Die ID des gelöschten Benutzers.
	274	• Result: Das Ergebnis der Löschung (z. B. Success, UserNotFound, SystemUser).
	275
1.1	276	= Set-AESBUserIsEnabled =
	277
3.1	278
	279
	280	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 Benutzer-IDs. Es ist nicht möglich, System-Benutzer (z.B. Operator) zu aktivieren/deaktivieren.
	281
	282
	283
	284	(% style="width:1952.33px" %)
	285	\|=Parameter \|=Datentyp\|=Optional\|=(% style="width: 1397px;" %)Beschreibung
	286	\|-ConnectionName\|String\|✅\|Der Name der Verbindung, über die Benutzer gelöscht werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
	287	\|-UserIds\|String[]\|❌\|Eine Liste von Benutzer-IDs der zu entfernenden Benutzer.
	288
	289
	290
	291
	292
1.1	293	= Set-AESBUserPassword =
	294
	295	= Set-AESBUserRoles =