uip oder Benutzer

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

uip or users manages Orchestrator users at the tenant level. Orchestrator users are backed by Identity Service (IS) — this tool does not create standalone users from scratch. Instead, users import references an existing IS directory principal (a user, group, robot account, or external application) and provisions it into the tenant; users update then edits the tenant-side properties (license, session permissions, unattended credentials) that live on the Orchestrator side. There is no users delete — user removal is managed through Identity Service or the Orchestrator portal, not this CLI. For folder-level role management, see 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	Import an existing Identity Service directory principal into the tenant.
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)	Update a user's tenant-side properties (PATCH semantics).
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 or users import

Import a directory principal — an Identity Service user, group, robot account, or external application — into this tenant. This is the only way this CLI provisions a new tenant user; there is no standalone "create a user" verb, because Orchestrator users are always backed by an IS principal.

References an existing IS principal by --username or --directory-id, plus --type to declare which kind of principal it is (the CLI does not guess). Optionally assigns folder roles in the same call with --folder-path/--folder-key and --role-keys — both a folder and roles must be provided together, or neither. --directory-id imports are idempotent: importing an already-imported principal by directory ID returns the existing tenant record instead of failing.

Robot accounts and external applications must be imported with --directory-id (the IS UUID) — Orchestrator can't resolve them by <domain>\<name> the way it resolves a directory user. Find the ID with uip admin robot-accounts list --search <name> or uip admin external-apps list.

Arguments and required identifiers

Name	Erforderlich	Zweck
--username	one of --username/--directory-id	Identity Service username (typically an email).
--directory-id	one of --username/--directory-id	Identity Service directory identifier (OIDC subject / IS UUID). Required for DirectoryRobot and DirectoryExternalApplication types.

Optionen

Short	Long	Wert	Standard	Beschreibung
–	--type	DirectoryUser | DirectoryGroup | DirectoryRobot | DirectoryExternalApplication	erforderlich	Directory principal type.
–	--domain	text	–	Directory domain name as configured in Identity Service. Only needed for on-premises environments with configured AD domains.
–	--folder-path	Pfad	–	Folder to assign the imported principal to. Use with --role-keys.
–	--folder-key	GUID	–	Folder alternative to --folder-path. Use with --role-keys.
–	--role-keys	CSV von GUIDs	–	Folder role GUIDs to grant. Requires a folder option; a folder option without --role-keys is also rejected.

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 is added when --directory-id matched a principal already present in the tenant.

uip oder Benutzer zuweisen

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

Hinweis:

CAUTION — destructive on roles. If --role-keys is passed, the server replaces all of the user's existing roles in the target folder with the ones supplied — roles not in the payload are removed silently. To preserve existing roles, read them first with roles user-roles list <principal-name> --type <type> and pass the full desired union to --role-keys. For additive tenant-level role membership on a role, use roles users set instead.

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

Remove a user from a folder. The user is not deleted — only their folder assignment is removed.

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 or users update

Update a user's tenant-side properties by key (GUID). Reads current values, merges the supplied fields, and saves. Provide at least one option.

edit is a registered alias for this verb — uip or users edit works identically to uip or users update.

Reliably editable: license profile, session flags, and unattended robot credentials. Identity attributes (--name, --surname, --email, --type) are accepted by the API, but for directory principals (DirectoryUser/Group/Robot/ExternalApplication) those fields are normally synced from Identity Service — changing them here only edits the Orchestrator-side cached copy and may be overwritten on the next IS sync. For a durable identity change, edit the IS principal directly.

This command does not expose role assignments — use users assign (folder roles) or users assign-roles (tenant roles) for that; the current tenant role list is always re-sent unchanged so an update never touches it.

Argumente

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

Optionen

Identity (Orchestrator-side cache only for directory principals)

Long	Wert	Beschreibung
--name	text	New first name.
--surname	text	New last name.
--email	text	New email address.
--type	text	New user type (for example User, DirectoryUser).

License and session permissions

Long	Wert	Beschreibung
--license-type	text	For example 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 account for unattended execution (for example DOMAIN\user).
--unattended-password	text	Password, or — for a read-only credential store — the external secret reference name.
--credential-store-key	GUID	Credential store for unattended execution credentials. Use credential-stores list to find it.
--credential-type	Default | SmartCard	Credential type.
--limit-concurrent / --no-limit-concurrent	Markieren	Die gleichzeitige Ausführung auf mehreren Maschinen zulassen oder nicht zulassen.

If you set any unattended-credential flag on a user with no existing UnattendedRobot record, both --unattended-username and --unattended-password are required together — Orchestrator silently discards an incomplete record, so the CLI refuses to submit one rather than report a false success. Editing an existing record accepts any subset of these 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

Assign tenant-level roles to a user.

Hinweis:

CAUTION — destructive. The server replaces the user's entire tenant-level role list with the keys passed via --role-keys — roles not in the payload are removed silently. To preserve existing tenant roles, read them first with roles user-roles list <principal-name> --type <type> and pass the full desired union to --role-keys. Unlike users assign (folder-level roles), this sets roles that apply across the entire tenant.

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 — manage roles, role-user membership, and principal permission inspection (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.