uip oder Benutzer

Syntax und Optionen für „UIP oder Benutzer“, die Orchestrator-Mandantenbenutzer und deren Ordner- und Rollenzuweisungen verwaltet.

uip or users verwaltet Orchestrator-Benutzer auf Mandantenebene. Orchestrator-Benutzer werden von Identity Service (IS) unterstützt – dieses Tool erstellt keine eigenständigen Benutzer von Grund auf neu. Stattdessen verweist users import auf einen vorhandenen IS-Verzeichnisprinzipal (einen Benutzer, eine Gruppe, ein Roboterkonto oder eine externe Anwendung) und stellt es dem Mandanten bereit; users update bearbeitet dann die mandantenseitigen Eigenschaften (Lizenz, Sitzungsberechtigungen, Unattended-Anmeldeinformationen), die sich auf der Orchestrator-Seite befinden. Es gibt kein users delete – das Entfernen des Benutzers wird über Identity Service oder das Orchestrator-Portal verwaltet, nicht über diese CLI. Informationen zur Rollenverwaltung auf Ordnerebene finden Sie unter uip or roles.

Zusammenfassung

uip or users list [options]
uip or users list-in-folder [--folder-path <path> | --folder-key <key>] [options]
uip or users list-available [--folder-path <path> | --folder-key <key>] [options]
uip or users get <user-key>
uip or users import (--username <name> | --directory-id <id>) --type <type> [--folder-path <path> | --folder-key <key>] [--role-keys <keys>]
uip or users assign --user-key <key> [--folder-path <path> | --folder-key <key>] [--role-keys <keys>]
uip or users unassign --user-key <key> [--folder-path <path> | --folder-key <key>]
uip or users update <user-key> [options]
uip or users current
uip or users assign-roles <user-key> --role-keys <keys>

Verben

Verb	Zweck
list	Listen Sie Mandantenbenutzer mit optionalen Filtern auf.
list-in-folder	Listen Sie die einem Ordner zugewiesenen Benutzer mit ihren Rollen auf Ordnerebene auf.
list-available	Listen Sie Benutzer auf, die noch einem Ordner zugewiesen werden können (noch nicht zugewiesen).
get	Einen Benutzer nach Schlüssel abrufen.
import	Importieren Sie einen vorhandenen Identity Service-Verzeichnisprinzipal in den Mandanten.
assign	Weisen Sie einen Benutzer zu einem Ordner zu, optional mit Rollen auf Ordnerebene.
unassign	Entfernen Sie einen Benutzer aus einem Ordner.
update (Alias edit)	Aktualisieren Sie die mandantenseitigen Eigenschaften eines Benutzers (PATCH-Semantik).
current	Gibt Details des aktuell authentifizierten Benutzers zurück.
assign-roles	Ersetzen Sie die Rollenzuweisungen eines Benutzers auf Mandantenebene.

UIP oder Benutzerliste

Listen Sie Benutzer im Mandanten auf. Gibt den Benutzerschlüssel (GUID), den Benutzernamen, den vollständigen Namen, die E-Mail-Adresse, den Typ und den aktiven Status zurück.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--key	GUID	–	Nach Benutzerschlüssel filtern (exakte Übereinstimmung).
–	--username	text	–	Nach Benutzername filtern (enthält Übereinstimmung).
–	--email	text	–	Nach E-Mail-Adresse filtern (enthält Übereinstimmung).
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.
–	--sort-by	Feld	–	OData-Sortierung (z. B. UserName asc).
–	--all-fields	Markieren	aus	Geben Sie die vollständige API-Nutzlast anstelle der kuratierten Zusammenfassung zurück.

Beispiele

uip or users list --limit 10
uip or users list --username admin
uip or users list --output-filter 'Data[].{key:Key, name:UserName}'

Datenform (--output json)

{
  "Code": "UserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "[e-mail]",
      "FullName": "Admin User",
      "Email": "[e-mail]",
      "Type": "User",
      "IsActive": true
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0 }
}

UIP oder Benutzerliste im Ordner

Listen Sie die einem Ordner zugewiesenen Benutzer mit ihren Rollen auf Ordnerebene auf. Erfordert --folder-path oder --folder-key.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--folder-path	Pfad	–	Zielordner. Geben Sie dies oder --folder-key.
–	--folder-key	GUID	–	Zielordner. Geben Sie dies oder --folder-path.
–	--include-inherited	Markieren	aus	Zeigen Sie auch Benutzer an, die von übergeordneten Ordnern geerbt wurden.
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.
–	--sort-by	Feld	Id desc	OData-Sortierung.
–	--all-fields	Markieren	aus	Geben Sie die vollständige API-Nutzlast anstelle der kuratierten Zusammenfassung zurück.

Beispiele

uip or users list-in-folder --folder-path "Shared"
uip or users list-in-folder --folder-path "Shared" --include-inherited
uip or users list-in-folder --folder-path "Shared" \
    --output-filter 'Data[].{name:UserName, roles:Roles}'

Datenform (--output json)

{
  "Code": "UserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "[e-mail]",
      "FullName": "Admin User",
      "Type": "User",
      "IsInherited": false,
      "Roles": "Folder Administrator"
    }
  ]
}

UIP oder Benutzerliste verfügbar

Listen Sie Mandantenbenutzer auf, die noch einem Ordner zugewiesen werden können. Verwenden Sie die zurückgegebenen Schlüssel mit users assign oder roles assign.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--folder-path	Pfad	–	Zielordner. Geben Sie dies oder --folder-key.
–	--folder-key	GUID	–	Zielordner. Geben Sie dies oder --folder-path.
-s	--search	text	–	Nach Benutzername filtern (enthält Übereinstimmung).
-l	--limit	Nummer	50	Seitengröße.
–	--offset	Nummer	0	Anzahl der Überspringungen.

Beispiele

uip or users list-available --folder-path "Shared"
uip or users list-available --folder-path "Shared" --search admin
uip or users list-available --folder-path "Shared" \
    --output-filter 'Data[].Key'

Datenform (--output json)

{
  "Code": "UserAvailableList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000003",
      "UserName": "[e-mail]",
      "Roles": ""
    }
  ]
}

uip oder Benutzer abrufen

Rufen Sie einen Benutzer nach GUID-Schlüssel ab.

Argumente

Name	Erforderlich	Zweck
<user-key>	ja	Benutzerschlüssel (GUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--all-fields	Markieren	aus	Geben Sie die vollständige API-Nutzlast anstelle der kuratierten Zusammenfassung zurück.

Beispiele

uip or users get d4e5f6a7-0000-0000-0000-000000000001
uip or users get d4e5f6a7-0000-0000-0000-000000000001 --all-fields
uip or users get d4e5f6a7-0000-0000-0000-000000000001 --output-filter 'Data.Email'

Datenform (--output json)

{
  "Code": "User",
  "Data": {
    "Key": "d4e5f6a7-0000-0000-0000-000000000001",
    "UserName": "[e-mail]",
    "FullName": "Admin User",
    "Email": "[e-mail]",
    "Type": "User",
    "IsActive": true
  }
}

UIP oder Benutzerimport

Importieren Sie einen Verzeichnisprinzipal – einen Identity Service-Benutzer, eine Gruppe, ein Roboterkonto oder eine externe Anwendung – in diesen Mandanten. Dies ist die einzige Möglichkeit, mit dieser CLI einen neuen Mandantenbenutzer bereitzustellen; es gibt kein eigenständiges Element „Benutzer erstellen“ Verb, da Orchestrator-Benutzer immer von einem IS-Prinzipal unterstützt werden.

Verweist auf einen vorhandenen IS-Prinzipal durch --username oder --directory-id sowie --type, um zu deklarieren, um welche Art von Prinzipal es sich handelt (die CLI schätzt nicht). Weist optional Ordnerrollen im selben Aufruf mit --folder-path/--folder-key und --role-keys zu – sowohl ein Ordner als auch Rollen müssen zusammen bereitgestellt werden oder nicht. --directory-id -Importe sind idempotent: Das Importieren eines bereits importierten Prinzipals nach Verzeichnis-ID gibt den vorhandenen Mandantendatensatz zurück, anstatt fehlzuschlagen.

Roboterkonten und externe Anwendungen müssen mit --directory-id (der IS UUID) importiert werden – Orchestrator kann sie nicht durch <domain>\<name> auflösen, so wie er einen Verzeichnisbenutzer auflöst. Suchen Sie die ID mit uip admin robot-accounts list --search <name> oder uip admin external-apps list.

Argumente und erforderliche Bezeichner

Name	Erforderlich	Zweck
--username	eines von --username/--directory-id	Identity Service-Benutzername (normalerweise eine E-Mail-Adresse).
--directory-id	eines von --username/--directory-id	Identity Service-Verzeichnisbezeichner (OIDC-Antragsteller / IS UUID). Erforderlich für die Typen DirectoryRobot und DirectoryExternalApplication .

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--type	DirectoryUser | DirectoryGroup | DirectoryRobot | DirectoryExternalApplication	erforderlich	Verzeichnisprinzipaltyp.
–	--domain	text	–	Verzeichnisdomänenname, wie in Identity Service konfiguriert. Nur für lokale Umgebungen mit konfigurierten AD-Domänen erforderlich.
–	--folder-path	Pfad	–	Ordner, dem der importierte Prinzipal zugewiesen werden soll. Verwendung mit --role-keys.
–	--folder-key	GUID	–	Ordneralternative zu --folder-path. Mit --role-keys verwenden.
–	--role-keys	CSV von GUIDs	–	GUIDs für Ordnerrollen, die gewährt werden sollen. Erfordert eine Ordneroption; Eine Ordneroption ohne --role-keys wird ebenfalls abgelehnt.

Beispiele

uip or users import --username [e-mail]

uip or users import --username [e-mail] \
    --folder-path Shared --role-keys a1b2c3d4-0000-0000-0000-000000000001

# Robot account — directory ID required
uip or users import --directory-id 11111111-2222-3333-4444-555555555555 \
    --type DirectoryRobot

Datenform (--output json)

{
  "Code": "UserImported",
  "Data": {
    "UserName": "[e-mail]",
    "Type": "DirectoryUser",
    "AssignedFolderPath": "Shared",
    "AssignedRoleKeys": ["a1b2c3d4-0000-0000-0000-000000000001"]
  }
}

AlreadyImported: true wird hinzugefügt, wenn --directory-id mit einem bereits vorhandenen Prinzipal im Mandanten übereinstimmt.

uip oder Benutzer zuweisen

Weisen Sie einen Benutzer zu einem Ordner zu, optional mit Rollen auf Ordnerebene.

Hinweis:

ACHTUNG – destruktiv für Rollen. Wenn --role-keys übergeben wird, ersetzt der Server alle vorhandenen Rollen des Benutzers im Zielordner durch die angegebenen – Rollen, die nicht in der Nutzlast enthalten sind, werden im Hintergrund entfernt. Um vorhandene Rollen beizubehalten, lesen Sie sie zuerst mit roles user-roles list <principal-name> --type <type> und übergeben Sie die vollständige gewünschte Vereinigung an --role-keys. Verwenden Sie für die zusätzliche Rollenmitgliedschaft auf Mandantenebene für eine Rolle stattdessen roles users set.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--user-key	GUID	erforderlich	Benutzerschlüssel.
–	--role-keys	CSV von GUIDs	–	GUIDs für Ordner-Scope-Rollen.
–	--folder-path	Pfad	–	Zielordner. Geben Sie dies oder --folder-key.
–	--folder-key	GUID	–	Zielordner.

Beispiele

uip or users assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared"

uip or users assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared" \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002

uip or users assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared" --output-filter 'Data.Status'

Datenform (--output json)

{
  "Code": "UserAssigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "Status": "Assigned successfully"
  }
}

uip oder die Zuweisung von Benutzern aufheben

Entfernen Sie einen Benutzer aus einem Ordner. Der Benutzer wird nicht gelöscht – nur seine Ordnerzuweisung wird entfernt.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--user-key	GUID	erforderlich	Benutzerschlüssel.
–	--folder-path	Pfad	–	Ordner, aus dem entfernt werden soll. Geben Sie dies oder --folder-key.
–	--folder-key	GUID	–	Ordner, aus dem entfernt werden soll.

Beispiele

uip or users unassign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared"

uip or users unassign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-key b1c2d3e4-0000-0000-0000-000000000001

uip or users unassign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared" --output-filter 'Data.Status'

Datenform (--output json)

{
  "Code": "UserUnassigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "Status": "Unassigned successfully"
  }
}

uip oder Benutzeraktualisierung

Aktualisieren Sie die mandantenseitigen Eigenschaften eines Benutzers nach Schlüssel (GUID). Liest aktuelle Werte, führt die angegebenen Felder zusammen und speichert. Geben Sie mindestens eine Option an.

edit ist ein registrierter Alias für dieses Verb – uip or users edit funktioniert identisch mit uip or users update.

Zuverlässig bearbeitbar: Lizenzprofil, Sitzungs-Flags und Anmeldeinformationen für Unattended-Roboter. Identitätsattribute (--name, --surname, --email, --type) werden von der API akzeptiert, aber für Verzeichnisprinzipale (DirectoryUser/Group/Robot/ExternalApplication) sind diese Felder normal synchronisiert mit Identity Service – wenn Sie sie hier ändern, wird nur die auf Orchestrator-Seite zwischengespeicherte Kopie bearbeitet und kann bei der nächsten IS-Synchronisierung überschrieben werden. Für eine dauerhafte Identitätsänderung bearbeiten Sie den IS-Prinzipal direkt.

Dieser Befehl macht keine Rollenzuweisungen verfügbar – verwenden Sie users assign (Ordnerrollen) oder users assign-roles (Mandantenrollen) dafür; Die aktuelle Rollenliste des Mandanten wird immer unverändert erneut gesendet, sodass eine Aktualisierung sie nie beeinflusst.

Argumente

Name	Erforderlich	Zweck
<user-key>	ja	Benutzerschlüssel (GUID).

Optionen

Identität (Orchestrator-seitiges Cache nur für Verzeichnisprinzipale)

Long	Wert	Beschreibung
--name	text	Neuer Vorname.
--surname	text	Neuer Nachname.
--email	text	Neue E-Mail-Adresse.
--type	text	Neuer Benutzertyp (z. B. User, DirectoryUser).

Lizenz- und Sitzungsberechtigungen

Long	Wert	Beschreibung
--license-type	text	Zum Beispiel: Attended, Unattended, StudioPro.
--allow-unattended / --deny-unattended	Markieren	Die unbeaufsichtigte Auftragsausführung zulassen oder verweigern.
--allow-attended / --deny-attended	Markieren	Lassen Sie Attended-Sitzungen zulassen oder verweigern.
--allow-login / --deny-login	Markieren	Orchestrator-Anmeldung zulassen oder verweigern.
--allow-personal-workspace / --deny-personal-workspace	Markieren	Persönlichen Arbeitsbereich zulassen oder verweigern.
--active / --inactive	Markieren	Aktivieren oder deaktivieren Sie den Benutzer.

Anmeldeinformationen für die Unattended-Ausführung

Long	Wert	Beschreibung
--unattended-username	text	Windows-Konto für die Unattended-Ausführung (z. B. DOMAIN\user).
--unattended-password	text	Kennwort oder – für einen schreibgeschützten Anmeldeinformationsspeicher – der externe Geheimnisreferenzname.
--credential-store-key	GUID	Anmeldeinformationsspeicher für Anmeldeinformationen für die unbeaufsichtigte Ausführung. Verwenden Sie credential-stores list, um ihn zu finden.
--credential-type	Default | SmartCard	Anmeldeinformationstyp.
--limit-concurrent / --no-limit-concurrent	Markieren	Die gleichzeitige Ausführung auf mehreren Maschinen zulassen oder nicht zulassen.

Wenn Sie ein Unattended-Credential-Flag für einen Benutzer ohne vorhandenen UnattendedRobot -Datensatz festlegen, sind sowohl --unattended-username als auch --unattended-password zusammen erforderlich – der Orchestrator verwirft einen unvollständigen Datensatz im Hintergrund, sodass die CLI die Übermittlung verweigert, anstatt einen „false“ zu melden Erfolg Das Bearbeiten eines vorhandenen Datensatzes akzeptiert jede Teilmenge dieser Flags.

Beispiele

uip or users update d4e5f6a7-0000-0000-0000-000000000001 --email [e-mail]

uip or users update d4e5f6a7-0000-0000-0000-000000000001 \
    --allow-unattended --license-type Unattended \
    --unattended-username DOMAIN\\bot --unattended-password s3cret

uip or users update d4e5f6a7-0000-0000-0000-000000000001 --inactive \
    --output-filter 'Data.Status'

Datenform (--output json)

{
  "Code": "UserUpdated",
  "Data": { "Key": "d4e5f6a7-0000-0000-0000-000000000001", "Status": "Updated successfully" }
}

uip oder Benutzer aktuell

Gibt den aktuell authentifizierten Benutzer zurück. Nützlich zum Überprüfen der Sitzung und Erkennen Ihres eigenen Benutzerschlüssels.

Optionen

Short	Long	Wert	Standard	Beschreibung

Beispiele

uip or users current
uip or users current --output-filter 'Data.Key'
uip or users current --output table

Datenform (--output json)

Die gleiche User -Form wie users get.

uip oder Benutzer zugewiesenen-Rollen

Einem Benutzer Rollen auf Mandantenebene hinzufügen.

Hinweis:

ACHTUNG – destruktiv. Der Server ersetzt die gesamte Rollenliste des Benutzers auf Mandantenebene durch die über --role-keys übergebenen Schlüssel – Rollen, die nicht in der Nutzlast enthalten sind, werden im Hintergrund entfernt. Um vorhandene Mandantenrollen beizubehalten, lesen Sie sie zuerst mit roles user-roles list <principal-name> --type <type> und übergeben Sie die vollständige gewünschte Vereinigung an --role-keys. Im Gegensatz zu users assign (Rollen auf Ordnerebene) werden damit Rollen festgelegt, die für den gesamten Mandanten gelten.

Argumente

Name	Erforderlich	Zweck
<user-key>	ja	Benutzerschlüssel (GUID).

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--role-keys	CSV von GUIDs	erforderlich	Rollen-GUIDs, die im Mandanten-Scope zugewiesen werden sollen.

Beispiele

uip or users assign-roles d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001

uip or users assign-roles d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001,a1b2c3d4-0000-0000-0000-000000000002

uip or users assign-roles d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.RolesAssigned'

Datenform (--output json)

{
  "Code": "UserRolesAssigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "RolesAssigned": 1,
    "Status": "Assigned successfully"
  }
}

Exitcodes

Siehe Exitcodes. Keine Verb-spezifischen Überschreibungen.

Zugehörige Befehle

• uip or roles – Verwalten Sie Rollen, die Rollenbenutzermitgliedschaft und die Prüfung der Prinzipalberechtigung (roles user-roles list, roles user-permissions list).
• uip or folders – finden Sie Ordnerschlüssel für users assign / unassign.
• uip or jobs – insbesondere jobs start --user-keys.

Siehe auch

• Authentifizierung.
• Globale Optionen.