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.

Benutzer der UIP-Plattform

Syntax und Optionen für „UIP-Plattformbenutzer“, die die Zuweisung von Lizenzpaketen pro Benutzer über den Lizenzkontoführer verwalten.

uip platform users verwaltet die Zuweisung von Lizenzpaketen pro Benutzer über den Lizenzkontoführer sowie die Aufstockungen pro Benutzer und die Berichte zur Lizenz-/Verbrauchsmaterialien. Hier finden Sie drei unabhängige Befehlsgruppen: licenses (direkte/Gruppenpaketzuweisung), top-ups (Gewährung und Nachverfolgung von Verbrauchsmaterialien) und usage (Lizenzverbrauch pro Benutzer).

Zusammenfassung​

uip platform users licenses <verb> [options] [<user>]
uip platform users top-ups <verb> [options]
uip platform users usage <verb> [options] [<user>]
uip platform users licenses <verb> [options] [<user>]
uip platform users top-ups <verb> [options]
uip platform users usage <verb> [options] [<user>]

Verben​

„Gruppieren“ (Group)VerbZweck
licensessetWeisen Sie Benutzerpaketlizenzen direkt einem Verzeichnisbenutzer zu.
licensesgetListen Sie die Benutzerpaketverträge auf, die derzeit von einem Verzeichnisbenutzer verwaltet werden, mit der Quelle jeder Mandant.
licensesavailableRufen Sie die Zusammenfassung der Benutzerpaketlizenzen auf Kontoebene ab (insgesamt, zugewiesen, verfügbar).
top-upscreateGewähren Sie einem Benutzer eine Aufstockung aus dem aktiven Verbrauchspool der Organisation.
top-upsgetÜberprüfen Sie den Status eines Auftrags zur Aufstockungsgewährung.
top-upsrequestAufstockung für sich selbst anfordern; benachrichtigt die Administratoren der Organisation.
usagelistListen Sie Benutzer mit Lizenzverbrauch in der Organisation auf.
usagegetAnzeigen des Lizenzverbrauchs pro Benutzer (Ihre eigene oder ein Administrator, der den eines anderen Benutzers anzeigt).

Benutzerauflösung​

set und get verwenden ein <user> -Positionsargument – einen Namen oder ein E-Mail-Präfix. Die CLI sucht lokale und Verzeichnisbenutzer mit einer Übereinstimmung „beginnt mit“ und erfordert genau eine Übereinstimmung:

  • Keine Übereinstimmung → Fehler mit "No directory user found matching '<input>'.".
  • Mehrere Übereinstimmungen → Fehler beim Auflisten von bis zu 10 Kandidaten, sodass Sie die Eingabe optimieren können.

UIP-Plattformbenutzerlizenzen festgelegt​

Weisen Sie einem Verzeichnisbenutzer Benutzerpaketlizenzen zu. Pakete in --input ersetzen die direkt zugewiesenen Pakete des Benutzers; von Gruppenregeln geerbte Pakete sind von diesem Befehl nicht betroffen.

Argumente​

NameErforderlichZweck
<user>jaBenutzerbezeichner (Name oder E-Mail-Präfix; muss genau mit einem Verzeichnisbenutzer übereinstimmen).

Optionen​

LongWertStandardBeschreibung
--inputPfaderforderlichPfad zu einer JSON-Datei mit der gewünschten Benutzerlizenzzuweisung, z. B. [{"code":"RPADEVPRONU"},{"code":"ATTUNU"},{"code":"TSTNU"}].
--organizationKonto-IDSitzungsstandardGUID des Organisationskontos. Überschreiben Sie die von der aktuellen Anmeldung aufgelöste Organisation.

Beispiel​

uip platform users licenses set "dan.dinu@uipath.com" \
    --input ./user-bundles.json
uip platform users licenses set "dan.dinu@uipath.com" \
    --input ./user-bundles.json

user-bundles.json:

[
  { "code": "RPADEVPRONU" },
  { "code": "ATTUNU" },
  { "code": "TSTNU" }
]
[
  { "code": "RPADEVPRONU" },
  { "code": "ATTUNU" },
  { "code": "TSTNU" }
]

Datenform (--output json)​

{
  "Code": "UserLicensesSet",
  "Data": [
    { "code": "RPADEVPRONU", "name": "RPADEVPRONU" },
    { "code": "ATTUNU",      "name": "ATTUNU" },
    { "code": "TSTNU",       "name": "TSTNU" }
  ]
}
{
  "Code": "UserLicensesSet",
  "Data": [
    { "code": "RPADEVPRONU", "name": "RPADEVPRONU" },
    { "code": "ATTUNU",      "name": "ATTUNU" },
    { "code": "TSTNU",       "name": "TSTNU" }
  ]
}

Abrufen von Lizenzen für UIP-Plattformbenutzer​

Rufen Sie die Benutzerpaketlizenzen ab, die derzeit von einem Verzeichnisbenutzer geleert werden. Jede Zeile ist ein gemeinsam genutztes Paket. source ist "group" wenn der Mandant von einer Gruppenregel geerbt wird, oder "direct" für Zuweisungen ohne Gruppenregel.

Argumente​

NameErforderlichZweck
<user>jaBenutzerbezeichner (Name oder E-Mail-Präfix; muss genau mit einem Verzeichnisbenutzer übereinstimmen).

Optionen​

LongWertStandardBeschreibung
--organizationKonto-IDSitzungsstandardGUID des Organisationskontos. Überschreiben Sie die von der aktuellen Anmeldung aufgelöste Organisation.

Beispiel​

uip platform users licenses get "dan.dinu@uipath.com"
uip platform users licenses get "dan.dinu@uipath.com"

Datenform (--output json)​

{
  "Code": "UserLicenses",
  "Data": [
    {
      "source": "direct",
      "code": "RPADEVPRONU",
      "name": "RPADEVPRONU",
      "leasedAt": "2026-04-15T10:30:00.000Z"
    },
    {
      "source": "group",
      "code": "ATTUNU",
      "name": "ATTUNU",
      "leasedAt": "2026-04-20T08:15:00.000Z"
    }
  ]
}
{
  "Code": "UserLicenses",
  "Data": [
    {
      "source": "direct",
      "code": "RPADEVPRONU",
      "name": "RPADEVPRONU",
      "leasedAt": "2026-04-15T10:30:00.000Z"
    },
    {
      "source": "group",
      "code": "ATTUNU",
      "name": "ATTUNU",
      "leasedAt": "2026-04-20T08:15:00.000Z"
    }
  ]
}

Lizenzen für UIP-Plattformbenutzer verfügbar​

Rufen Sie die Zusammenfassung der Benutzerpaketlizenzen auf Kontoebene ab: wie viele Plätze pro Paket vorhanden sind (total), wie viele bereits zugewiesen sind (allocated) und wie viele noch verfügbar sind (available). Verwenden Sie dies vor der Zuweisung, um die Kapazität zu bestätigen.

Optionen​

LongWertStandardBeschreibung
--organizationKonto-IDSitzungsstandardGUID des Organisationskontos. Überschreiben Sie die von der aktuellen Anmeldung aufgelöste Organisation.

Beispiel​

uip platform users licenses available
uip platform users licenses available

Datenform (--output json)​

{
  "Code": "UserLicensesAvailable",
  "Data": [
    { "code": "RPADEVPRONU", "name": "RPADEVPRONU", "total": 100, "allocated": 42, "available": 58 },
    { "code": "ATTUNU",      "name": "ATTUNU",      "total": 50,  "allocated": 50, "available": 0 }
  ]
}
{
  "Code": "UserLicensesAvailable",
  "Data": [
    { "code": "RPADEVPRONU", "name": "RPADEVPRONU", "total": 100, "allocated": 42, "available": 58 },
    { "code": "ATTUNU",      "name": "ATTUNU",      "total": 50,  "allocated": 50, "available": 0 }
  ]
}

Top-ups für UIP-Plattformbenutzer​

Gewähren und nachverfolgen von Verbrauchsmaterialien pro Benutzer. Der Quellpool wird automatisch aus den aktiven Verbrauchsmaterialien der Organisation aufgelöst (PLTU bevorzugt, andernfalls AGU) – Sie übergeben den Pool nie explizit.

UIP-Plattformbenutzer erstellen Top-ups​

Gewähren Sie einem Benutzer eine Aufstockung.

Argumente​
NameErforderlichZweck
<user>jaBenutzerbezeichner (Name oder E-Mail-Präfix; muss genau mit einem Verzeichnisbenutzer übereinstimmen).
Optionen​
LongWertStandardBeschreibung
--waitMarkierenausWarten Sie, bis der Aufstockungsauftrag abgeschlossen ist, und melden Sie, ob er gewährt wurde.
--countInteger (1–100)1Anzahl der zu gewährenden Top-up-Units.
--organizationKonto-IDSitzungsstandardGUID des Organisationskontos.
Beispiele​
uip platform users top-ups create "jane.doe@example.com"
uip platform users top-ups create "jane.doe@example.com" --wait
uip platform users top-ups create "jane.doe@example.com" --count 5
uip platform users top-ups create "jane.doe@example.com"
uip platform users top-ups create "jane.doe@example.com" --wait
uip platform users top-ups create "jane.doe@example.com" --count 5
Datenform (--output json)​

Ohne --wait:

{
  "Code": "TopUpStarted",
  "Data": {
    "jobId": "b3f1c2d4-0000-0000-0000-000000000009",
    "status": "started",
    "pool": "AGU",
    "poolPercentConsumed": 42
  }
}
{
  "Code": "TopUpStarted",
  "Data": {
    "jobId": "b3f1c2d4-0000-0000-0000-000000000009",
    "status": "started",
    "pool": "AGU",
    "poolPercentConsumed": 42
  }
}

Mit --wait:

{
  "Code": "TopUpCompleted",
  "Data": {
    "jobId": "b3f1c2d4-0000-0000-0000-000000000009",
    "status": "completed",
    "pool": "AGU",
    "poolPercentConsumed": 42,
    "granted": true,
    "rejectionReason": null
  }
}
{
  "Code": "TopUpCompleted",
  "Data": {
    "jobId": "b3f1c2d4-0000-0000-0000-000000000009",
    "status": "completed",
    "pool": "AGU",
    "poolPercentConsumed": 42,
    "granted": true,
    "rejectionReason": null
  }
}

UIP-Plattformbenutzer erhalten Top-ups​

Überprüfen Sie den Status eines Auftrags zur Aufstockungsgewährung.

Argumente​
NameErforderlichZweck
<job-id>jaAufstockungsauftrags-ID, die von top-ups create zurückgegeben wird.
Optionen​
LongWertStandardBeschreibung
--organizationKonto-IDSitzungsstandardGUID des Organisationskontos.
Beispiel​
uip platform users top-ups get b3f1c2d4-0000-0000-0000-000000000009
uip platform users top-ups get b3f1c2d4-0000-0000-0000-000000000009
Datenform (--output json)​
{
  "Code": "TopUpStatus",
  "Data": {
    "jobId": "b3f1c2d4-0000-0000-0000-000000000009",
    "status": "completed",
    "granted": true,
    "rejectionReason": null
  }
}
{
  "Code": "TopUpStatus",
  "Data": {
    "jobId": "b3f1c2d4-0000-0000-0000-000000000009",
    "status": "completed",
    "granted": true,
    "rejectionReason": null
  }
}

Top-ups-Anforderung für UIP-Plattformbenutzer​

Fordern Sie eine Aufstockung für sich selbst an (den angemeldeten Benutzer). Dadurch werden die Administratoren Ihrer Organisation benachrichtigt – es wird nichts direkt gewährt.

Optionen​
LongWertStandardBeschreibung
--organizationKonto-IDSitzungsstandardGUID des Organisationskontos.
Beispiel​
uip platform users top-ups request
uip platform users top-ups request
Datenform (--output json)​
{
  "Code": "TopUpRequested",
  "Data": {
    "userId": "11111111-1111-1111-1111-111111111111",
    "outcome": "NotificationSent",
    "message": "Your administrators have been notified."
  }
}
{
  "Code": "TopUpRequested",
  "Data": {
    "userId": "11111111-1111-1111-1111-111111111111",
    "outcome": "NotificationSent",
    "message": "Your administrators have been notified."
  }
}

Ein Nicht-NotificationSent -Ergebnis (z. B. NotEligible oder NoActiveDistribution) wird als Fehler mit der Meldung des Servers zurückgegeben.

Nutzung der UIP-Plattform durch Benutzer​

Zeigen Sie den Lizenzverbrauch pro Benutzer an: monatlicher Pool in Prozent (in Prozent) und Aufstockungsportfolio in Prozent (in Prozent).

Nutzungsliste der UIP-Plattformbenutzer​

Listen Sie Benutzer mit Lizenzverbrauch in der Organisation auf.

Optionen​
LongWertStandardBeschreibung
--limitIntegerStandardseitengrößeMaximale Anzahl der zurückzugebenden Benutzer.
--offsetInteger0Anzahl der Benutzer, die übersprungen werden sollen.
--sort-byFeld–Sortieren nach einem Feld der Zeile der Benutzernutzung (z. B. email, displayName).
--sort-orderascdesc–
--license-codesdurch Leerzeichen getrennte Codes–Filtern Sie nach Benutzern, die über bestimmte Lizenzpakete verfügen (z. B. RPADEVPRONU ATTUNU).
--organizationKonto-IDSitzungsstandardGUID des Organisationskontos.
Beispiele​
uip platform users usage list
uip platform users usage list --limit 50 --offset 50 --sort-by email --sort-order asc --license-codes RPADEVPRONU ATTUNU
uip platform users usage list
uip platform users usage list --limit 50 --offset 50 --sort-by email --sort-order asc --license-codes RPADEVPRONU ATTUNU
Datenform (--output json)​
{
  "Code": "UserUsageList",
  "Data": [
    {
      "userId": "11111111-1111-1111-1111-111111111111",
      "email": "jane.doe@example.com",
      "displayName": "Jane Doe",
      "licenses": ["RPADEVPRONU"],
      "strongestLicense": "RPADEVPRONU",
      "monthlyPercentConsumed": 64,
      "topUpWalletPercentConsumed": 20,
      "topups": 2,
      "status": "TopUp"
    }
  ]
}
{
  "Code": "UserUsageList",
  "Data": [
    {
      "userId": "11111111-1111-1111-1111-111111111111",
      "email": "jane.doe@example.com",
      "displayName": "Jane Doe",
      "licenses": ["RPADEVPRONU"],
      "strongestLicense": "RPADEVPRONU",
      "monthlyPercentConsumed": 64,
      "topUpWalletPercentConsumed": 20,
      "topups": 2,
      "status": "TopUp"
    }
  ]
}

monthlyPercentConsumed ist null (nicht 0), wenn der Benutzer keine monatliche Zulage hat. status ist einer von MonthlyLimit, TopUp, PaidUnits.

Abrufen der Nutzung der UIP-Plattformbenutzer​

Zeigt den Lizenzverbrauch pro Benutzer an: den monatlichen Prozentsatz jedes Verbrauchsmaterials, das Zurücksetzungsdatum, die Aufschlüsselung pro Dienst und den Aufstockungsbetrag, wenn vorhanden.

Argumente​
NameErforderlichZweck
[user]neinBenutzerbezeichner (Name oder E-Mail-Präfix). Auslassen, um die eigene Nutzung des angemeldeten Benutzers anzuzeigen; Übergeben Sie einen (Administratorpfad), um den anderen Benutzer anzuzeigen.
Optionen​
LongWertStandardBeschreibung
--organizationKonto-IDSitzungsstandardGUID des Organisationskontos.
Beispiele​
uip platform users usage get
uip platform users usage get "jane.doe@example.com"
uip platform users usage get
uip platform users usage get "jane.doe@example.com"
Datenform (--output json)​
{
  "Code": "UserUsage",
  "Data": {
    "userId": "11111111-1111-1111-1111-111111111111",
    "consumables": [
      {
        "entitlement": "AgenticPool",
        "monthlyPercentConsumed": 64,
        "resetsOn": "2026-08-01T00:00:00.000Z",
        "services": [
          { "service": "AgentDevelopment", "serviceName": "Agent Development", "percentOfPool": 40 }
        ],
        "topUpWallet": {
          "monthlyPercentConsumed": 20,
          "topups": 2,
          "firstGrantedOn": "2026-07-10T09:00:00.000Z",
          "services": [],
          "topupCountPerMonth": [
            { "month": "2026-07-01T00:00:00.000Z", "topupCount": 2 }
          ]
        }
      }
    ]
  }
}
{
  "Code": "UserUsage",
  "Data": {
    "userId": "11111111-1111-1111-1111-111111111111",
    "consumables": [
      {
        "entitlement": "AgenticPool",
        "monthlyPercentConsumed": 64,
        "resetsOn": "2026-08-01T00:00:00.000Z",
        "services": [
          { "service": "AgentDevelopment", "serviceName": "Agent Development", "percentOfPool": 40 }
        ],
        "topUpWallet": {
          "monthlyPercentConsumed": 20,
          "topups": 2,
          "firstGrantedOn": "2026-07-10T09:00:00.000Z",
          "services": [],
          "topupCountPerMonth": [
            { "month": "2026-07-01T00:00:00.000Z", "topupCount": 2 }
          ]
        }
      }
    ]
  }
}

Exitcodes​

Siehe Exitcodes. Keine Verb-spezifischen Überschreibungen.

  • uip platform groups – Gruppenregeln, die Pakete an viele Benutzer gleichzeitig Leasing geben (diese werden mit source: "group" in users licenses get angezeigt).
  • uip platform tenants – Zuweisung von Runtime und Verbrauchsmaterialien auf Mandantenebene.

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