uip oder Benutzer

uip or users verwaltet Orchestrator-Benutzer auf Mandantenebene – listet, erstellt, bearbeitet und löscht Benutzer und weist sie Ordnern zu und verwaltet Rollenzuweisungen auf Mandantenebene. Informationen zur Rollenverwaltung auf Ordnerebene finden Sie unter uip or roles.

Zusammenfassung

uip or users <verb> [options]

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.
create	Einen neuen Benutzer erstellen; Weisen Sie optional Mandantenrollen zu und legen Sie Anmeldeinformationen für die Unattended-Ausführung fest.
delete	Benutzer nach Schlüssel löschen.
assign	Weisen Sie einen Benutzer zu einem Ordner zu, optional mit Rollen auf Ordnerebene.
unassign	Entfernen Sie einen Benutzer aus einem Ordner.
edit	Benutzereigenschaften bearbeiten (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.
–	--order-by	Feld	–	OData-Sortierung (z. B. UserName asc).
–	--all-fields	Markieren	aus	Gibt die vollständige API-Nutzlast 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, "HasMore": false }
}

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
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
–	--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.
–	--order-by	Feld	Id desc	OData-Sortierung.

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
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
–	--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
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.
–	--all-fields	Markieren	aus	Gibt die vollständige API-Nutzlast 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 Benutzer erstellen

Neuen Mandantenbenutzer erstellen Nur --username ist erforderlich. Die API erfordert rolesList, sodass --role-keys in der Praxis effektiv erforderlich ist – verwenden Sie es mit GUIDs für Mandanten-Scope-Rollen.

Optionen

Identität

Short	Long	Wert	Standard	Beschreibung
–	--username	text	erforderlich	Benutzername für die Anmeldung.
–	--name	text	–	Vorname.
–	--surname	text	–	Nachname.
–	--email	text	–	dieselbe E-Mail-Adresse erhält.
–	--type	ENUM	–	Benutzertyp (z. B. User, DirectoryUser).
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.

Rollen und Lizenz

Short	Long	Wert	Standard	Beschreibung
–	--role-keys	CSV von GUIDs	–	GUIDs für Mandanten-Scope-Rollen (aufgelöst in Rollennamen für die API-Nutzlast).
–	--license-type	ENUM	–	Zum Beispiel: Attended, Unattended, StudioPro.

Sitzungsberechtigungen (Flag-Paare)

Short	Long	Wert	Standard	Beschreibung
–	--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

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

Beispiele

uip or users create --username [e-mail] --email [e-mail] \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001

uip or users create --username [e-mail] --name Bot --surname Worker \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002 \
    --unattended-username DOMAIN\\bot --unattended-password s3cret

uip or users create --username [e-mail] \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Key'

Datenform (--output json)

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

uip oder Benutzer löschen

Löschen Sie einen Benutzer endgültig aus dem Mandanten.

Argumente

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

Optionen

Short	Long	Wert	Standard	Beschreibung
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.

Beispiele

uip or users delete d4e5f6a7-0000-0000-0000-000000000010
uip or users delete d4e5f6a7-0000-0000-0000-000000000010 --output-filter 'Data.Status'
uip or users delete d4e5f6a7-0000-0000-0000-000000000010 --output plain

Datenform (--output json)

{
  "Code": "UserDeleted",
  "Data": { "Key": "d4e5f6a7-0000-0000-0000-000000000010", "Status": "Deleted successfully" }
}

uip oder Benutzer zuweisen

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

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.
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.

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.

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.
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.

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 Benutzer bearbeiten

Bearbeiten Sie einen Benutzer nach Schlüssel. Liest aktuelle Werte, führt die angegebenen Felder zusammen und speichert. Geben Sie mindestens eine Option zum Aktualisieren an.

Argumente

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

Optionen

Die gleichen Flags wie users create, mit Ausnahme von --username (kann nicht geändert werden) und --role-keys (verwenden Sie stattdessen users assign-roles ). Alle Flag-Paare aus Sitzung und Berechtigung, der Lizenztyp und die Optionen für Unattended-Anmeldeinformationen gelten.

Beispiele

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

uip or users edit d4e5f6a7-0000-0000-0000-000000000001 \
    --allow-unattended --license-type Unattended

uip or users edit 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
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.

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. Dies ersetzt die aktuellen Mandantenrollen des Benutzers – verwenden Sie roles set-role-users für eine zusätzliche Mitgliedschaft auf Rollenebene.

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.
-t	--tenant	name	Sitzungsstandard	Überschreiben Sie den Mandanten.

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 und Rollenbenutzermitgliedschaften.
• 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.