UiPath Documentation
uipath-cli
latest
false
UiPath-CLI-Benutzerhandbuch
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

uip-Administratorbenutzer

Syntax und Optionen für „UIP Admin Users“ und „UIP Admin Groups“, die Identity Server-Verzeichnisbenutzer, -Gruppen und -Gruppenmitgliedschaften verwalten.

uip admin users und uip admin groups verwalten lokale Identity Server-Benutzer und -Gruppen innerhalb der Partition Ihrer Organisation – die Identitäten auf Verzeichnisebene hinter der Anmeldung und nicht die Rollenzuweisungen auf Orchestrator-Ebene. Hier befinden sich zwei unabhängige Befehlsgruppen: users (Verzeichnisbenutzer erstellen/lesen/aktualisieren/löschen/einladen) und groups (Gruppen erstellen/lesen/aktualisieren/löschen sowie Mitgliedschaftsverwaltung).

--organization wird für die meisten Verben in beiden Gruppen akzeptiert, ist aber veraltet und ignoriert – die Organisation wird immer von Ihrem aktuellen Anmeldekontext abgeleitet. Wenn sie übergeben wird, wird eine Warnung ausgegeben (--organization is deprecated and ignored; organization is derived from login context), aber das hat keine Auswirkungen.

Zusammenfassung​

uip admin users list [--search <term>] [--sort-by <field>] [--sort-order asc|desc] [--limit <n>] [--offset <n>]
uip admin users get <user-id>
uip admin users create <username> --email <email> [--name <name>] [--surname <surname>]
uip admin users update <user-id> [--email <email>] [--name <name>] [--surname <surname>]
uip admin users delete <user-id>
uip admin users invite --email <emails> [--name <name>] [--surname <surname>]

uip admin groups list
uip admin groups get <group-id>
uip admin groups create <name>
uip admin groups update <group-id> --name <name>
uip admin groups delete <group-id>
uip admin groups members list <group-id> [--limit <n>] [--offset <n>]
uip admin groups members add <group-id> --user-ids <ids>
uip admin groups members revoke <group-id> --user-ids <ids>
uip admin users list [--search <term>] [--sort-by <field>] [--sort-order asc|desc] [--limit <n>] [--offset <n>]
uip admin users get <user-id>
uip admin users create <username> --email <email> [--name <name>] [--surname <surname>]
uip admin users update <user-id> [--email <email>] [--name <name>] [--surname <surname>]
uip admin users delete <user-id>
uip admin users invite --email <emails> [--name <name>] [--surname <surname>]

uip admin groups list
uip admin groups get <group-id>
uip admin groups create <name>
uip admin groups update <group-id> --name <name>
uip admin groups delete <group-id>
uip admin groups members list <group-id> [--limit <n>] [--offset <n>]
uip admin groups members add <group-id> --user-ids <ids>
uip admin groups members revoke <group-id> --user-ids <ids>

Verben​

„Gruppieren“ (Group)VerbZweck
userslistListen Sie Benutzer in der Partition auf (durchsuchbar, sortierbar, paginiert).
usersgetRufen Sie die vollständigen Details eines Benutzers nach ID ab.
userscreateNeuen lokalen Benutzer erstellen
usersupdateAktualisieren Sie die E-Mail-Adresse, den Vor- oder Nachnamen eines Benutzers.
usersdeleteLöschen Sie einen Benutzer nach ID.
usersinviteLaden Sie einen oder mehrere Benutzer per E-Mail ein.
groupslistAlle Gruppen in der Partition auflisten.
groupsgetRufen Sie die Details einer Gruppe nach ID ab.
groupscreateNeue lokale Gruppe erstellen.
groupsupdateEine Gruppe umbenennen.
groupsdeleteLöschen Sie eine Gruppe nach ID.
groups memberslistListen Sie die Mitglieder einer Gruppe auf.
groups membersaddFügen Sie einen oder mehrere Benutzer zu einer Gruppe hinzu.
groups membersrevokeEntfernen Sie einen oder mehrere Benutzer aus einer Gruppe.

UIP-Administratorbenutzerliste​

Listen Sie Benutzer in der Partition auf. Gibt Benutzer-ID, Benutzername, E-Mail-Adresse, Name und Erstellungszeit zurück.

Optionen​

LongShortWertStandardBeschreibung
--search <term>-sstring–Suchen Sie Benutzer anhand des Namens oder der E-Mail-Adresse.
--sort-by <field>string–Sortierfeld, z. B UserName, Email).
--sort-order <direction>asc|descascSortierrichtung.
--limit <number>-lInteger50 (DEFAULT_PAGE_SIZE)Anzahl der zurückzugebenden Elemente.
--offset <number>Integer0Anzahl der zu überspringenden Elemente.
--login-validity <minutes>Integer–Überschreiben Sie die Tokenvalidität für diesen Anruf.

Beispiel​

uip admin users list --limit 5
uip admin users list --limit 5

Datenform (--output json)​

{
  "Code": "UserList",
  "Data": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "userName": "admin@example.com",
      "email": "admin@example.com",
      "name": "Admin",
      "surname": "User",
      "displayName": "Admin User",
      "creationTime": "2026-01-15T10:00:00.000Z"
    }
  ]
}
{
  "Code": "UserList",
  "Data": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "userName": "admin@example.com",
      "email": "admin@example.com",
      "name": "Admin",
      "surname": "User",
      "displayName": "Admin User",
      "creationTime": "2026-01-15T10:00:00.000Z"
    }
  ]
}

UIP-Administratorbenutzer erhalten​

Rufen Sie Benutzerdetails nach ID ab.

Argumente​

NameErforderlichZweck
<user-id>jaBenutzer-ID (UUID). Finden Sie es mit users list.

Beispiel​

uip admin users get a1b2c3d4-0000-0000-0000-000000000001
uip admin users get a1b2c3d4-0000-0000-0000-000000000001

Datenform (--output json)​

{
  "Code": "UserDetails",
  "Data": {
    "id": "a1b2c3d4-0000-0000-0000-000000000001",
    "userName": "admin@example.com",
    "email": "admin@example.com",
    "name": "Admin",
    "surname": "User",
    "displayName": "Admin User",
    "creationTime": "2026-01-15T10:00:00.000Z"
  }
}
{
  "Code": "UserDetails",
  "Data": {
    "id": "a1b2c3d4-0000-0000-0000-000000000001",
    "userName": "admin@example.com",
    "email": "admin@example.com",
    "name": "Admin",
    "surname": "User",
    "displayName": "Admin User",
    "creationTime": "2026-01-15T10:00:00.000Z"
  }
}

UIP-Administratorbenutzer erstellen​

Neuen lokalen Benutzer erstellen

Argumente​

NameErforderlichZweck
<username>jaBenutzername für den neuen Benutzer.

Optionen​

LongShortWertErforderlichBeschreibung
--email <email>-eE-Mailjadieselbe E-Mail-Adresse erhält.
--name <name>-nstringneinVorname.
--surname <surname>stringneinNachname.

Beispiel​

uip admin users create newuser --email "user@example.com" --name "John" --surname "Doe"
uip admin users create newuser --email "user@example.com" --name "John" --surname "Doe"

Datenform (--output json)​

{ "Code": "UserCreated", "Data": { "Succeeded": true } }
{ "Code": "UserCreated", "Data": { "Succeeded": true } }

Aktualisierung der UIP-Administratorbenutzer​

Aktualisieren Sie die E-Mail-Adresse, den Vor- oder Nachnamen eines vorhandenen Benutzers. Mindestens ein Feld ist erforderlich – der Aufruf mit keinem Feld schlägt auf der Clientseite ("No fields to update") vor einem Netzwerkaufruf fehl.

Argumente​

NameErforderlichZweck
<user-id>jaBenutzer-ID (UUID).

Optionen​

LongShortWertBeschreibung
--email <email>-eE-MailNeue E-Mail-Adresse.
--name <name>-nstringNeuer Vorname.
--surname <surname>stringNeuer Nachname.

Beispiel​

uip admin users update a1b2c3d4-0000-0000-0000-000000000001 --name "Jane" --surname "Doe" --email "jane@example.com"
uip admin users update a1b2c3d4-0000-0000-0000-000000000001 --name "Jane" --surname "Doe" --email "jane@example.com"

Datenform (--output json)​

{ "Code": "UserUpdated" }
{ "Code": "UserUpdated" }

UIP-Administratorbenutzer löschen​

Löschen Sie einen Benutzer nach ID.

Argumente​

NameErforderlichZweck
<user-id>jaBenutzer-ID (UUID).

Beispiel​

uip admin users delete a1b2c3d4-0000-0000-0000-000000000001
uip admin users delete a1b2c3d4-0000-0000-0000-000000000001

Datenform (--output json)​

{ "Code": "UserDeleted", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Status": "Deleted successfully" } }
{ "Code": "UserDeleted", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Status": "Deleted successfully" } }

UIP-Administratorbenutzer einladen​

Laden Sie einen oder mehrere Benutzer per E-Mail ein. Sendet eine Einladung zum Beitritt zur Organisation.

Optionen​

LongShortWertErforderlichBeschreibung
--email <emails>-edurch Kommas getrennt sindjaEine oder mehrere E-Mail-Adressen, die eingeladen werden sollen.
--name <name>-nstringneinVorname, der auf jeden eingeladenen Benutzer angewendet wird.
--surname <surname>stringneinNachname wird auf jeden eingeladenen Benutzer angewendet.

Beispiel​

uip admin users invite --email "user@example.com"
uip admin users invite --email "user@example.com"

Datenform (--output json)​

{ "Code": "UsersInvited", "Data": { "succeeded": true } }
{ "Code": "UsersInvited", "Data": { "succeeded": true } }

UIP-Administratorgruppenliste​

Alle Gruppen in der Partition auflisten. Gibt Gruppen-ID, Namen, Typ und Erstellungszeit zurück. Keine Filter-/Paginierungsoptionen – gibt alles in einem Aufruf zurück.

Beispiel​

uip admin groups list
uip admin groups list

Datenform (--output json)​

{
  "Code": "GroupList",
  "Data": [
    { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Administrators", "displayName": "Administrators", "type": "BuiltIn", "creationTime": "2026-01-15T10:00:00.000Z" }
  ]
}
{
  "Code": "GroupList",
  "Data": [
    { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Administrators", "displayName": "Administrators", "type": "BuiltIn", "creationTime": "2026-01-15T10:00:00.000Z" }
  ]
}

UIP-Administratorgruppen abrufen​

Rufen Sie Gruppendetails nach ID ab.

Argumente​

NameErforderlichZweck
<group-id>jaGruppen-ID (UUID). Finden Sie es mit groups list.

Beispiel​

uip admin groups get a1b2c3d4-0000-0000-0000-000000000001
uip admin groups get a1b2c3d4-0000-0000-0000-000000000001

Datenform (--output json)​

{ "Code": "GroupDetails", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Administrators", "displayName": "Administrators", "type": "BuiltIn", "creationTime": "2026-01-15T10:00:00.000Z" } }
{ "Code": "GroupDetails", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Administrators", "displayName": "Administrators", "type": "BuiltIn", "creationTime": "2026-01-15T10:00:00.000Z" } }

UIP-Administratorgruppen erstellen​

Neue lokale Gruppe erstellen.

Argumente​

NameErforderlichZweck
<name>jaGruppenname.

Beispiel​

uip admin groups create "DevOps Team"
uip admin groups create "DevOps Team"

Datenform (--output json)​

{ "Code": "GroupCreated", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000002", "name": "DevOps Team", "displayName": "DevOps Team", "type": "Custom" } }
{ "Code": "GroupCreated", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000002", "name": "DevOps Team", "displayName": "DevOps Team", "type": "Custom" } }

Der Befehl generiert eine clientseitige UUID für den id der Gruppe, bevor er die API aufruft – der Server weist die Gruppenerstellung mit einem 409er Fehler zurück, wenn keine ID angegeben wird.

Aktualisierung der UIP-Administratorgruppen​

Eine Gruppe umbenennen. --name ist das einzige aktualisierte Feld und ist erforderlich – das Entfernen schlägt auf Clientseite fehl ("No fields to update").

Argumente​

NameErforderlichZweck
<group-id>jaGruppen-ID (UUID).

Optionen​

LongShortWertErforderlichBeschreibung
--name <name>-nstringjaNeuer Gruppenname.

Beispiel​

uip admin groups update a1b2c3d4-0000-0000-0000-000000000001 --name "Renamed Group"
uip admin groups update a1b2c3d4-0000-0000-0000-000000000001 --name "Renamed Group"

Datenform (--output json)​

{ "Code": "GroupUpdated" }
{ "Code": "GroupUpdated" }

UIP-Administratorgruppen löschen​

Löschen Sie eine Gruppe nach ID.

Argumente​

NameErforderlichZweck
<group-id>jaGruppen-ID (UUID).

Beispiel​

uip admin groups delete a1b2c3d4-0000-0000-0000-000000000002
uip admin groups delete a1b2c3d4-0000-0000-0000-000000000002

Datenform (--output json)​

{ "Code": "GroupDeleted", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000002", "Status": "Deleted successfully" } }
{ "Code": "GroupDeleted", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000002", "Status": "Deleted successfully" } }

Liste der Mitglieder der UIP-Administratorgruppe​

Listen Sie die Mitglieder einer Gruppe auf.

Argumente​

NameErforderlichZweck
<group-id>jaGruppen-ID (UUID).

Optionen​

LongShortWertStandardBeschreibung
--limit <number>-lInteger50Anzahl der zurückzugebenden Elemente.
--offset <number>Integer0Anzahl der zu überspringenden Elemente.

Beispiel​

uip admin groups members list a1b2c3d4-0000-0000-0000-000000000001
uip admin groups members list a1b2c3d4-0000-0000-0000-000000000001

Datenform (--output json)​

{ "Code": "GroupMembers", "Data": [] }
{ "Code": "GroupMembers", "Data": [] }

UIP-Administratorgruppen Mitglieder hinzufügen​

Fügen Sie einen oder mehrere Benutzer zu einer Gruppe hinzu.

Hinweis:

Implementiert als Read-Modify-Write: Der Befehl ruft den aktuellen Namen der Gruppe ab und ruft dann die Gruppenaktualisierungs-API mit directoryUserIDsToAdd auf – der gleiche zugrunde liegende Vorgang wie groups update, nur mit einem anderen Nutzlastfeld. Es gibt kein dediziertes „Mitglied hinzufügen“ API-Aufruf.

Argumente​

NameErforderlichZweck
<group-id>jaGruppen-ID (UUID).

Optionen​

LongWertErforderlichBeschreibung
--user-ids <ids>durch Kommas getrennt sindjaHinzuzufügende Benutzer-IDs. Finden Sie sie mit users list.

Beispiel​

uip admin groups members add a1b2c3d4-0000-0000-0000-000000000001 --user-ids "user-id-1,user-id-2"
uip admin groups members add a1b2c3d4-0000-0000-0000-000000000001 --user-ids "user-id-1,user-id-2"

Datenform (--output json)​

{ "Code": "GroupMembersAdded" }
{ "Code": "GroupMembersAdded" }

UIP-Administratorgruppenmitglieder widerrufen​

Entfernen Sie einen oder mehrere Benutzer aus einer Gruppe. Der gleiche Lese-, Änderungs- und Schreibmechanismus wie members add mit directoryUserIDsToRemove.

Argumente​

NameErforderlichZweck
<group-id>jaGruppen-ID (UUID).

Optionen​

LongWertErforderlichBeschreibung
--user-ids <ids>durch Kommas getrennt sindjaZu entfernende Benutzer-IDs. Muss aktuelle Mitglieder sein.

Beispiel​

uip admin groups members revoke a1b2c3d4-0000-0000-0000-000000000001 --user-ids "user-id-1"
uip admin groups members revoke a1b2c3d4-0000-0000-0000-000000000001 --user-ids "user-id-1"

Datenform (--output json)​

{ "Code": "GroupMembersRevoked" }
{ "Code": "GroupMembersRevoked" }

Siehe auch​

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben