Changes for page UserManagement Cmdlets

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

From 1.3 to 2.1 From 3.1 to 4.1

From version 2.1

edited by jklein
on 2025/07/17 08:04

Change comment: There is no comment for this version

To version 3.1

edited by jklein
on 2025/07/17 09:55

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -91,18 +91,205 @@
  Dieses Cmdlet dient dazu, einen neuen Benutzer anzulegen.
++(% style="width:1952.33px" %)
++|=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
++|-ConnectionName|String|✅|Der Name der Verbindung, über die der Benutzer angelegt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++|-UserName|String|❌|Name des neuen Users.
++|-Password|SecureString|❌|Passwort des neuen Users.
++|-FirstName|String|✅|Vorname des neuen Users.
++|-LastName|String|✅|Nachname des neuen Users.
++|-IsEnabled|Bool|✅|Der neuangelegte Benutzer kann über diesen Parameter aktiviert oder deaktiviert werden. Default ist der User ist aktiviert.
++|-Roles|String[]|✅|Rechte die dem neuen Benutzer zugewiesen werden können.
++=== Beispiele ===
++Beispiel 1: Neuen Benutzer anlegen
++{{code language="powershell"}}
++Add-AESBUser -Username "TestUser" -Password $password
++{{/code}}
++Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" an.
++
++Beispiel 2: Neuen Benutzer mit weiteren Parametern anlegen
++
++{{code language="powershell"}}
++Add-AESBUser -Username "TestUser" -Password $password -FirstName "Test" -LastName "NachnameTest"
++
++{{/code}}
++
++Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" und weiteren Parametern wie FirstName und LastName an.
++
++Beispiel 3: Neuen Benutzer mit entsprechenden Rollen anlegen
++
++{{code language="powershell"}}
++Add-AESBUser -Username "TestUser" -Password $password -FirstName "Test" -LastName "NachnameTest" -Roles ReadOnly
++
++{{/code}}
++
++Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" an und weist ihm die "ReadOnly" Rolle zu.
++
++Beispiel 4: Neuen nicht aktiven Benutzer anlegen
++
++{{code language="powershell"}}
++Add-AESBUser -Username "TestUser" -Password $password -IsEnabled $false
++{{/code}}
++
++Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" aktiviert diesen aber noch nicht.
++
++=== Rückgabewert ===
++
++Objekt zur weiteren Verarbeitung mit der UserId des neu angelegten Benutzers und einer ResultInfo über das Anlegen des neuen Users.
++
  = Edit-AESBUser =
++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.
++
++(% style="width:1952.33px" %)
++|=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
++|-ConnectionName|String|✅|Der Name der Verbindung, über die der Benutzer bearbeitet werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++|-UserId|String|❌|Die eindeutige Kennung des Benutzers, dessen Daten geändert werden sollen.
++|-FirstName|String|✅❌*|Der neue Vorname des Benutzers.
++|-LastName|String|✅❌*|Der neue Nachname des Benutzers.
++
++{{aagon.infobox}}
++Die mit * gekennzeichneten Parameter sind je nach Parametersatz optional oder obligatorisch.
++{{/aagon.infobox}}
++
++(% class="box infomessage" %)
++(((
++[[image:https://doc.aagon.com/bin/download/XWiki/Aagon Infobox/WebHome/Information.svg||alt="Hinweis" height="32" width="32"]]  **Hinweis: **
++
++Die mit * gekennzeichneten Parameter sind je nach Parametersatz optional oder obligatorisch.
++)))
++
++Parametersets
++
++* FirstNameOnly: Nur der Vorname wird geändert (UserId, FirstName).
++* LastNameOnly: Nur der Nachname wird geändert (UserId, LastName).
++* BothNames: Vor- und Nachname werden geändert (UserId, FirstName, LastName).
++
++=== Beispiele ===
++
++Beispiel 1: FirstNameOnly: Dieser Parametersatz wird verwendet, um ausschließlich den Vornamen eines Benutzers zu ändern.
++
++* Erforderliche Parameter: UserId, FirstName
++
++{{code language="powershell"}}
++Edit-AESBUser -UserId "benutzer123" -FirstName "Max"
++
++{{/code}}
++
++Dieser Befehl ändert den Vornamen des Benutzers mit der ID "benutzer123" zu "Max".
++
++Beispiel 2: LastNameOnly: Dieser Parametersatz wird verwendet, um ausschließlich den Nachnamen eines Benutzers zu ändern.
++
++* Erforderliche Parameter: UserId, LastName
++
++{{code language="powershell"}}
++Edit-AESBUser -UserId "benutzer123" -LastName "Mustermann"
++
++{{/code}}
++
++Dieser Befehl ändert den Nachnamen des Benutzers mit der ID "benutzer123" zu "Mustermann".
++
++Beispiel 3: BothNames: Dieser Parametersatz wird verwendet, um sowohl den Vor- als auch den Nachnamen eines Benutzers gleichzeitig zu ändern.
++Erforderliche Parameter: UserId, FirstName, LastName
++
++{{code language="powershell"}}
++Edit-AESBUser -UserId "benutzer123" -FirstName "Max" -LastName "Mustermann"
++{{/code}}
++
++Dieser Befehl ändert den Vornamen des Benutzers mit der ID "benutzer123" zu "Max" und den Nachnamen zu "Mustermann".
++
++=== Rückgabewert ===
++
++Bei Erfolg gibt das Cmdlet ein Objekt mit den Eigenschaften UserId und Result "Success" zurück. Bei Fehlern wird eine Exception ausgelöst.
++
  = Get-AESBUsers =
++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.
++
++(% style="width:1952.33px" %)
++|=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
++|-ConnectionName|String|✅|Der Name der Verbindung, über die Benutzer-Informationen abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++|-UserIds|String[]|❌|Eine Liste von Benutzern, deren Daten geändert werden sollen.
++
++=== Beispiele ===
++
++Beispiel 1: Abrufen aller Benutzer
++
++{{code language="powershell"}}
++Get-AESBUsers
++{{/code}}
++
++Beispiel 2: Abrufen spezifischer Benutzer
++
++{{code language="powershell"}}
++Get-AESBUsers -UserIds "ffffffff-ffff-ffff-ffff-ffffffffffff", "ffffffff-ffff-ffff-ffff-ffffffffffff"
++
++{{/code}}
++
++=== Rückgabewert ===
++
++Das Cmdlet gibt eine Liste von UserInformation-Objekten zurück. Jedes Objekt enthält folgende Eigenschaften:
++•    UserId: Die eindeutige ID des Benutzers.
++•    Username: Der Benutzername.
++•    FirstName: Der Vorname des Benutzers.
++•    LastName: Der Nachname des Benutzers.
++•    UserStatus: Der Status des Benutzers (z. B. Aktiviert, Deaktiviert, Gesperrt).
++•    UserType: Der Typ des Benutzers (z. B. Normal, System).
++•    Roles: Eine Liste der Rollen des Benutzers.
++•    Rights: Eine Liste der Rechte des Benutzers.
++•    DomainName: Der Name der Domäne, zu der der Benutzer gehört.
++•    DomainId: Die ID der Domäne.
++•    ProcessStatus: Der Verarbeitungsstatus (z. B. Erfolgreich, Fehler).
++
++=== Fehlerbehandlung ===
++
++•    Warnungen: Wenn keine Benutzer gefunden werden, wird eine Warnung ausgegeben.
++•    Fehler: Bei schwerwiegenden Fehlern wird ein TerminatingError ausgelöst.
++
  = Remove-AESBUsers =
++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.
++
++(% style="width:1952.33px" %)
++|=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
++|-ConnectionName|String|✅|Der Name der Verbindung, über die Benutzer gelöscht werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++|-UserIds|String[]|❌|Eine Liste von Benutzer-IDs der zu entfernenden Benutzer.
++
++=== Beispiele ===
++
++Beispiel 1: Entfernen mehrerer Benutzer
++
++{{code language="powershell"}}
++Remove-AESBUsers -UserIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2", "ffffffff-ffff-ffff-ffff-fffffffffff3"
++{{/code}}
++
++=== Rückgabewert ===
++
++Das Cmdlet gibt eine Liste von UserDeletionResult-Objekten zurück, die die folgenden Eigenschaften enthalten:
++•    UserId: Die ID des gelöschten Benutzers.
++•    Result: Das Ergebnis der Löschung (z. B. Success, UserNotFound, SystemUser).
++
  = Set-AESBUserIsEnabled =
++
++
++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.
++
++
++
++(% style="width:1952.33px" %)
++|=Parameter |=Datentyp|=Optional|=(% style="width: 1397px;" %)Beschreibung
++|-ConnectionName|String|✅|Der Name der Verbindung, über die Benutzer gelöscht werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++|-UserIds|String[]|❌|Eine Liste von Benutzer-IDs der zu entfernenden Benutzer.
++
++
++
++
++
  = Set-AESBUserPassword =
  = Set-AESBUserRoles =