UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip platform users

Syntax and options for `uip platform users`, which manages per-user license-bundle allocation through the License Accountant.

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).

Synopsis​

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

Verbs​

GroupVerbPurpose
licensessetAllocate user bundle licenses directly to a directory user.
licensesgetList the user-bundle leases currently held by a directory user, with the source of each lease.
licensesavailableGet the account-level summary of user-bundle licenses (total, allocated, available).
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).

User resolution​

set and get take a <user> positional argument — a name or email prefix. The CLI searches local and directory users with a "starts with" match and requires exactly one match:

  • No match → error with "No directory user found matching '<input>'.".
  • Multiple matches → error listing up to 10 candidates so you can refine the input.

uip platform users licenses set​

Allocate user bundle licenses to a directory user. Bundles in --input replace the user's directly-allocated bundles; bundles inherited from group rules are unaffected by this command.

Arguments​

NameRequiredPurpose
<user>yesUser identifier (name or email prefix; must match exactly one directory user).

Options​

LongValueDefaultDescription
--inputpathrequiredPath to a JSON file with the desired user license allocation, for example [{"code":"RPADEVPRONU"},{"code":"ATTUNU"},{"code":"TSTNU"}].
--organizationaccount-idsession defaultOrganization account GUID. Override the org resolved from the current login.

Example​

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

Data shape (--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" }
  ]
}

uip platform users licenses get​

Get the user bundle licenses currently leased by a directory user. Each row is one leased bundle; source is "group" when the lease is inherited from a group rule, or "direct" for non-group allocations.

Arguments​

NameRequiredPurpose
<user>yesUser identifier (name or email prefix; must match exactly one directory user).

Options​

LongValueDefaultDescription
--organizationaccount-idsession defaultOrganization account GUID. Override the org resolved from the current login.

Example​

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

Data shape (--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"
    }
  ]
}

uip platform users licenses available​

Get the account-level summary of user-bundle licenses: how many seats per bundle exist (total), how many are already allocated (allocated), and how many remain available (available). Use this before allocating to confirm capacity.

Options​

LongValueDefaultDescription
--organizationaccount-idsession defaultOrganization account GUID. Override the org resolved from the current login.

Example​

uip platform users licenses available
uip platform users licenses available

Data shape (--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.

Arguments​
NameRequiredPurpose
<user>yesUser identifier (name or email prefix; must match exactly one directory user).
Options​
LongValueDefaultDescription
--waitflagoffWait until the top-up job finishes and report whether it was granted.
--countinteger (1-100)1Number of top-up units to grant.
--organizationaccount-idsession defaultOrganization account GUID.
Examples​
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
Data shape (--output json)​

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

With --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.

Arguments​
NameRequiredPurpose
<job-id>yesTop-up job id returned by top-ups create.
Options​
LongValueDefaultDescription
--organizationaccount-idsession defaultOrganization account GUID.
Example​
uip platform users top-ups get b3f1c2d4-0000-0000-0000-000000000009
uip platform users top-ups get b3f1c2d4-0000-0000-0000-000000000009
Data shape (--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.

Options​
LongValueDefaultDescription
--organizationaccount-idsession defaultOrganization account GUID.
Example​
uip platform users top-ups request
uip platform users top-ups request
Data shape (--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.

Options​
LongValueDefaultDescription
--limitintegerdefault page sizeMaximum number of users to return.
--offsetinteger0Number of users to skip.
--sort-byfield—Sort by a field of the user usage row (for example email, displayName).
--sort-orderascdesc—
--license-codesspace-separated codes—Filter to users holding specific license bundles (for example RPADEVPRONU ATTUNU).
--organizationaccount-idsession defaultOrganization account GUID.
Examples​
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
Data shape (--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.

Arguments​
NameRequiredPurpose
[user]noUser identifier (name or email prefix). Omit to show the logged-in user's own usage; pass one (admin path) to see another user's.
Options​
LongValueDefaultDescription
--organizationaccount-idsession defaultOrganization account GUID.
Examples​
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"
Data shape (--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 }
          ]
        }
      }
    ]
  }
}

Exit codes​

See Exit codes. No verb-specific overrides.

  • uip platform groups — group rules that lease bundles to many users at once (these appear with source: "group" in users licenses get).
  • uip platform tenants — tenant-level runtime and consumable allocation.

See also​

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated