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 manages per-user license-bundle allocation through the License Accountant, plus per-user consumable top-ups and license/consumable usage reporting. Three independent command groups live here: licenses (direct/group bundle allocation), top-ups (grant and track consumable top-ups), and usage (per-user license consumption).

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-upscreateGrant a top-up to a user from the organization's active consumable pool.
top-upsgetCheck the status of a top-up grant job.
top-upsrequestRequest a top-up for yourself; notifies the organization's admins.
usagelistList users with license consumption in the organization.
usagegetShow per-user license consumption (your own, or an admin viewing another user's).

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 }
  ]
}

uip platform users top-ups

Grant and track per-user consumable top-ups. The source pool is resolved automatically from the organization's active consumables (PLTU preferred, else AGU) — you never pass the pool explicitly.

uip platform users top-ups create

Grant a top-up to a user.

Argumente
NameErforderlichZweck
<user>jaBenutzerbezeichner (Name oder E-Mail-Präfix; muss genau mit einem Verzeichnisbenutzer übereinstimmen).
Optionen
LongWertStandardBeschreibung
--waitMarkierenausWait until the top-up job finishes and report whether it was granted.
--countinteger (1-100)1Number of top-up units to grant.
--organizationKonto-IDSitzungsstandardOrganization account GUID.
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 platform users top-ups get

Check the status of a top-up grant job.

Argumente
NameErforderlichZweck
<job-id>jaTop-up job id returned by top-ups create.
Optionen
LongWertStandardBeschreibung
--organizationKonto-IDSitzungsstandardOrganization account GUID.
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
  }
}

uip platform users top-ups request

Request a top-up for yourself (the logged-in user). This notifies your organization's admins — it does not grant anything directly.

Optionen
LongWertStandardBeschreibung
--organizationKonto-IDSitzungsstandardOrganization account GUID.
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."
  }
}

A non-NotificationSent outcome (for example NotEligible or NoActiveDistribution) is returned as a failure with the server's message.

uip platform users usage

View per-user license consumption: monthly pool percent-consumed and top-up wallet percent-consumed.

uip platform users usage list

List users with license consumption in the organization.

Optionen
LongWertStandardBeschreibung
--limitIntegerdefault page sizeMaximale Anzahl der zurückzugebenden Benutzer.
--offsetInteger0Anzahl der Benutzer, die übersprungen werden sollen.
--sort-byFeldSort by a field of the user usage row (for example email, displayName).
--sort-orderascdesc
--license-codesspace-separated codesFilter to users holding specific license bundles (for example RPADEVPRONU ATTUNU).
--organizationKonto-IDSitzungsstandardOrganization account GUID.
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 is null (not 0) when the user has no monthly allowance. status is one of MonthlyLimit, TopUp, PaidUnits.

uip platform users usage get

Show per-user license consumption: each consumable's monthly percent consumed, reset date, per-service breakdown, and top-up wallet when present.

Argumente
NameErforderlichZweck
[user]neinUser identifier (name or email prefix). Omit to show the logged-in user's own usage; pass one (admin path) to see another user's.
Optionen
LongWertStandardBeschreibung
--organizationKonto-IDSitzungsstandardOrganization account GUID.
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