UserManagement Cmdlets
Add-AESBRole
Dieses Cmdlet fügt eine neue Rolle mit den angegebenen Rechten hinzu.
| Parameter | Datentyp | Erforderlich | Beschreibung |
|---|---|---|---|
| -ConnectionName | String | ❌ | Der Name der Verbindung, über die die Rolle erstellt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet. |
| -RoleName | String | ✅ | Name der Rolle. |
| -Rights | String[] | ✅ | Rechte für die Rolle. |
| -NoConfirm | SwitchParameter | ❌ | Beim Hinzufügen fehlender Abhängigkeitsrechte soll der Benutzer nicht jedes mal bestätigen müssen. |
Note:
Wenn ein Hauptrecht mit allen Unterrechten hinzugefügt werden soll, muss folgende Schreibweise verwendet werden: "Dashboard_*" für das Hauptrecht "Dashboard" mit allen Unterrechten.
Warning:
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!
Beispiele
Beispiel 1: Neue Rolle erstellen
Dieses Beispiel erstellt eine neue Rolle mit dem Namen "MyNewTestRole" und den Rechten für "Workflows".
Beispiel 2: Neue Rolle mit mehreren Rechten erstellen
Dieses Beispiel erstellt eine Rolle mit dem Namen "MyNewTestRole" und mehreren Rechten.
Beispiel 3: Neue Rolle mit mehreren Rechten erstellen und dem optionalen Switchparameter erstellen
Dieses Beispiel erstellt eine Rolle mit dem Namen "MyNewTestRole" mit mehreren Rechten.
Durch den Parameter -NoConfirm werden notwendige, aber fehlende Abhängigkeitsrechte ohne Zustimmung des Benutzers zur Rolle hinzugefügt.
Rückgabewert
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.
Get-AESBRole
Dieses Cmdlet zeigt für eine Rolle die Rechte-Hierarchie und die zugeordneten Benutzer an.
| Parameter | Datentyp | Erforderlich | Beschreibung |
|---|---|---|---|
| -ConnectionName | String | ❌ | Der Name der Verbindung, über die die Informationen zur Rolle abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet. |
| -RoleId | String | ✅ | Die eindeutige ID der Rolle, für die die Benutzer- und Rechte-Hierarchie angezeigt werden soll. |
Beispiele
Beispiel 1: Aufruf mit direkter Übergabe der RoleId
Rückgabewert
Das Cmdlet gibt eine formatierte Zeichenkette mit der Hierarchie der Benutzer und Rechte der angegebenen Rolle zurück.
Get-AESBRoleList
Dieses Cmdlet dient dazu, eine Liste von Rollen aus dem User-Management-System abzurufen und als PowerShell-Objekte auszugeben.
| Parameter | Datentyp | Erforderlich | Beschreibung |
|---|---|---|---|
| -ConnectionName | String | ❌ | Der Name der Verbindung, über die die Informationen zur Rolle abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet. |
| -RoleId | String | ✅ | Die eindeutige ID der Rolle, für die die Benutzer- und Rechte-Hierarchie angezeigt werden soll. |
Beispiele
Rückgabewert
Gibt eine Liste von Rollen als PowerShell-Objekte zurück.
Add-AESBUser
Dieses Cmdlet dient dazu, einen neuen Benutzer anzulegen.
| Parameter | Datentyp | Erforderlich | 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 neu angelegte 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
Dieses Beispiel legt einen neuen Benutzer mit dem Namen "TestUser" an.
Beispiel 2: Neuen Benutzer mit weiteren Parametern anlegen
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
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
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. Mit diesem Cmdlet ist es nicht möglich, System-Benutzer (z.B. Operator) oder aus der ACMP importierte ACMP-Benutzer/AD-Benutzer zu bearbeiten.
| Parameter | Datentyp | Erforderlich | 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. |
Note:
Die mit * gekennzeichneten Parameter sind je nach Parametersatz erforderlich oder optional .
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
Dieser Befehl ändert den Vornamen des Benutzers mit der ID "ffffffff-ffff-ffff-ffff-ffffffffffff" zu "Max".
Beispiel 2: LastNameOnly: Dieser Parametersatz wird verwendet, um ausschließlich den Nachnamen eines Benutzers zu ändern.
- Erforderliche Parameter: UserId, LastName
Dieser Befehl ändert den Nachnamen des Benutzers mit der ID "ffffffff-ffff-ffff-ffff-ffffffffffff" 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
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.
| Parameter | Datentyp | Erforderlich | 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
Beispiel 2: Abrufen spezifischer Benutzer
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 UserIds und führt die Löschung asynchron durch. Mit diesem Cmdlet ist es nicht möglich, System-Benutzer (z.B. Operator) zu entfernen.
| Parameter | Datentyp | Erforderlich | 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
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 UserIds. Mit diesem Cmdlet ist es nicht möglich, System-Benutzer (z.B. Operator) zu aktivieren/deaktivieren.
| Parameter | Datentyp | Erforderlich | Beschreibung |
|---|---|---|---|
| -ConnectionName | String | ❌ | Der Name der Verbindung, über die Benutzer aktiviert / deaktiviert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet. |
| -UserIds | String[] | ✅ | Eine Liste von Benutzer-IDs, deren Status geändert werden soll. |
| -Enable | SwitchParameter | ✅❌* | Aktiviert die angegebenen Benutzer. Kann nicht zusammen mit "-Disable" verwendet werden. |
| -Disable | SwitchParameter | ✅❌* | Deaktiviert die angegebenen Benutzer. Kann nicht zusammen mit "-Enable" verwendet werden. |
Note:
* Entweder Enable oder Disable ist erforderlich.
Beispiele
Beispiel 1: Benutzer aktivieren
2
3
4
5
Set-AESBUserIsEnabled -UserIds "ffffffff-ffff-ffff-ffff-ffffffffffff" -Enable
#Mehrere Benutzer aktivieren
Set-AESBUserIsEnabled -UserIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2" -Enable
Beispiel 2: Benutzer deaktivieren
2
3
4
5
Set-AESBUserIsEnabled -UserIds "ffffffff-ffff-ffff-ffff-ffffffffffff" -Disable
#Mehrere Benutzer deaktivieren
Set-AESBUserIsEnabled -UserIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2" -Disable
Rückgabewert
• Gibt für jeden erfolgreich verarbeiteten Benutzer ein aktualisiertes UserInfo-Objekt zurück.
Set-AESBUserPassword
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.
| Parameter | Datentyp | Erforderlich | Beschreibung |
|---|---|---|---|
| -ConnectionName | String | ❌ | Der Name der Verbindung, über die das Benutzer-Passwort geändert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet. |
| -UserId | String | ✅ | Die Benutzer-ID des Benutzers, dessen Passwort geändert werden soll. |
| -Password | Secure String | ✅ | Das neue Passwort für den Benutzer als Secure String. |
Beispiele
Beispiel 1: Passwort für einen Benutzer ändern
Rückgabewert
• Bei erfolgreicher Änderung: Ein anonymes Objekt mit UserId und Status = "Success".
• Bei Fehlern: PowerShell-Fehlerausgabe mit passender Fehlermeldung.
Set-AESBUserRoles
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.
| Parameter | Datentyp | Erforderlich | Beschreibung |
|---|---|---|---|
| -ConnectionName | String | ❌ | Der Name der Verbindung, über die die Rollen des Benutzers geändert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet. |
| -UserId | String | ✅ | Die Benutzer-ID des Benutzers, dessen Passwort geändert werden soll. |
| -Roles | List<RoleInfo> | ✅ | Die Liste der zuzuweisenden Rollen. Kann leer sein, um alle Rollen zu entfernen. |
Beispiele
Beispiel 1: Rollen für einen Benutzer setzen
Beispiel 2: Alle Rollen eines Benutzers entfernen
Rückgabewert
• Gibt für jeden erfolgreich verarbeiteten Benutzer die zugewiesenen Rollen (RoleInfo-Objekte) zurück.
• Gibt ein Platzhalterobjekt zurück, wenn keine Rollen zugewiesen wurden.