UiPath CLI - uip platform tenants

uipath-cli

latest

false

UiPath CLI user guide

uip platform tenants

Syntax and options for `uip platform tenants`, which reads and updates per-tenant license allocations.

uip platform tenants reads and updates per-tenant license allocations, and manages per-folder outcome billing configuration. licenses get returns the active product allocation for a tenant (allocated, available, consumed, validity window); licenses set overlays a JSON delta of {code, quantity} entries, routing each product code to the service license that already owns it within the tenant. folder-outcome-billing get/set reads and toggles whether a specific folder in a tenant has outcome billing enabled.

Synopsis

uip platform tenants licenses <verb> [options] <tenant-key>
uip platform tenants folder-outcome-billing <verb> [options] <tenant-id> <folder-key>
uip platform tenants licenses <verb> [options] <tenant-key>
uip platform tenants folder-outcome-billing <verb> [options] <tenant-id> <folder-key>

Verbs

Group	Verb	Purpose
`licenses`	`get`	Get the active license summary for a tenant (one row per product, dates as ISO).
`licenses`	`set`	Apply a delta of `{code, quantity}` entries to a tenant's runtime licenses and consumables, auto-routed across service-types.
`folder-outcome-billing`	`get`	Get the outcome billing configuration for a folder in a tenant.
`folder-outcome-billing`	`set`	Enable or disable outcome billing for a folder in a tenant.

uip platform tenants licenses get

Get the license summary for a tenant: allocated, available, consumed quantities per product code, with friendly names. Returns one row per active product (consumables and runtime licenses alike).

Arguments

Name	Required	Purpose
`<tenant-key>`	yes	Tenant key (GUID).

Options

Long	Value	Default	Description
`--organization`	account-id	session default	Organization account GUID. Override the org resolved from the current login.

Example

uip platform tenants licenses get 296b7134-6691-43db-b48a-2d95ed3ab031
uip platform tenants licenses get 296b7134-6691-43db-b48a-2d95ed3ab031

Data shape (--output json)

{
  "Code": "TenantLicenses",
  "Data": [
    {
      "code": "PLTU",
      "name": "Platform Units",
      "allocated": 300,
      "availableForAllocation": 4700,
      "allocatedAcrossOtherTenants": 0,
      "totalUnitsInAccount": 5000,
      "consumed": 50,
      "startDate": "2023-11-14T22:13:20.000Z",
      "endDate": "2027-09-15T18:40:00.000Z"
    }
  ]
}
{
  "Code": "TenantLicenses",
  "Data": [
    {
      "code": "PLTU",
      "name": "Platform Units",
      "allocated": 300,
      "availableForAllocation": 4700,
      "allocatedAcrossOtherTenants": 0,
      "totalUnitsInAccount": 5000,
      "consumed": 50,
      "startDate": "2023-11-14T22:13:20.000Z",
      "endDate": "2027-09-15T18:40:00.000Z"
    }
  ]
}

uip platform tenants licenses set

Set runtime licenses and consumables for a tenant. The CLI fetches the tenant's existing service licenses, indexes their products by code, and routes each input entry to the service license that already owns that code. Quantities in --input overlay the current allocation by code; products you do not list keep their existing quantities.

The command fails before writing if any input code:

is not present in any of the tenant's existing service licenses (unrouted), or
appears under more than one of the tenant's service licenses (ambiguous routing).

On partial failure (one service-type fails to update after another already succeeded), the error message lists the service types that were already applied so you can re-run with the same input idempotently.

Arguments

Name	Required	Purpose
`<tenant-key>`	yes	Tenant key (GUID).

Options

Long	Value	Default	Description
`--input`	path	required	Path to a JSON file with the product delta, for example `[{"code":"UNATT","quantity":5}]`. Quantities overlay the current allocation by product code.
`--organization`	account-id	session default	Organization account GUID. Override the org resolved from the current login.

Example

uip platform tenants licenses set 296b7134-6691-43db-b48a-2d95ed3ab031 \
    --input ./delta.json
uip platform tenants licenses set 296b7134-6691-43db-b48a-2d95ed3ab031 \
    --input ./delta.json

delta.json:

[
  { "code": "PLTU", "quantity": 500 },
  { "code": "RU",   "quantity": 100 }
]
[
  { "code": "PLTU", "quantity": 500 },
  { "code": "RU",   "quantity": 100 }
]

Data shape (--output json)

{
  "Code": "TenantLicensesSet",
  "Data": [
    {
      "serviceType": "orchestrator",
      "code": "PLTU",
      "name": "Platform Units",
      "quantity": 500
    },
    {
      "serviceType": "orchestrator",
      "code": "RU",
      "name": "Robot Units",
      "quantity": 100
    }
  ]
}
{
  "Code": "TenantLicensesSet",
  "Data": [
    {
      "serviceType": "orchestrator",
      "code": "PLTU",
      "name": "Platform Units",
      "quantity": 500
    },
    {
      "serviceType": "orchestrator",
      "code": "RU",
      "name": "Robot Units",
      "quantity": 100
    }
  ]
}

uip platform tenants folder-outcome-billing

View and manage the outcome billing configuration of a tenant's folders.

uip platform tenants folder-outcome-billing get

Get the outcome billing configuration for a folder: whether outcome billing is enabled.

Arguments

Name	Required	Purpose
`<tenant-id>`	yes	Tenant id (GUID).
`<folder-key>`	yes	Folder key (GUID).

Options

Long	Value	Default	Description
`--organization`	account-id	session default	Organization account GUID.

Example

uip platform tenants folder-outcome-billing get 296b7134-6691-43db-b48a-2d95ed3ab031 11111111-1111-1111-1111-111111111111
uip platform tenants folder-outcome-billing get 296b7134-6691-43db-b48a-2d95ed3ab031 11111111-1111-1111-1111-111111111111

Data shape (--output json)

{
  "Code": "TenantFolderOutcomeBilling",
  "Data": {
    "FolderKey": "11111111-1111-1111-1111-111111111111",
    "IsOutcomeBillingEnabled": true
  }
}
{
  "Code": "TenantFolderOutcomeBilling",
  "Data": {
    "FolderKey": "11111111-1111-1111-1111-111111111111",
    "IsOutcomeBillingEnabled": true
  }
}

uip platform tenants folder-outcome-billing set

Enable or disable outcome billing for a folder. Returns the configuration now in effect.

Arguments

Name	Required	Purpose
`<tenant-id>`	yes	Tenant id (GUID).
`<folder-key>`	yes	Folder key (GUID).

Options

Long	Value	Default	Description
`--enabled`	`true`	`false`	required
`--organization`	account-id	session default	Organization account GUID.

Examples

uip platform tenants folder-outcome-billing set 296b7134-6691-43db-b48a-2d95ed3ab031 11111111-1111-1111-1111-111111111111 --enabled true
uip platform tenants folder-outcome-billing set 296b7134-6691-43db-b48a-2d95ed3ab031 11111111-1111-1111-1111-111111111111 --enabled false
uip platform tenants folder-outcome-billing set 296b7134-6691-43db-b48a-2d95ed3ab031 11111111-1111-1111-1111-111111111111 --enabled true
uip platform tenants folder-outcome-billing set 296b7134-6691-43db-b48a-2d95ed3ab031 11111111-1111-1111-1111-111111111111 --enabled false

Data shape (--output json)

{
  "Code": "TenantFolderOutcomeBillingSet",
  "Data": {
    "FolderKey": "11111111-1111-1111-1111-111111111111",
    "IsOutcomeBillingEnabled": true
  }
}
{
  "Code": "TenantFolderOutcomeBillingSet",
  "Data": {
    "FolderKey": "11111111-1111-1111-1111-111111111111",
    "IsOutcomeBillingEnabled": true
  }
}

Exit codes

See Exit codes. No verb-specific overrides.

uip platform licenses consumables — organization-level consumables report (per-tenant pool usage, daily and folder breakdowns).
uip platform users — per-user license bundles.
uip or licenses — Orchestrator-level machine and named-user license assignment.

Was this page helpful?

PREVIOUSuip platform

NEXTusers

Synopsis​

Verbs​

uip platform tenants licenses get​

Arguments​

Options​

Example​

Data shape (--output json)​

uip platform tenants licenses set​

Arguments​

Options​

Example​

Data shape (--output json)​

uip platform tenants folder-outcome-billing​

uip platform tenants folder-outcome-billing get​

Arguments​

Options​

Example​

Data shape (--output json)​

uip platform tenants folder-outcome-billing set​

Arguments​

Options​

Examples​

Data shape (--output json)​

Exit codes​

Related commands​

See also​

Was this page helpful?

Synopsis

Verbs

uip platform tenants licenses get

Arguments

Options

Example

Data shape (--output json)

uip platform tenants licenses set

Arguments

Options

Example

Data shape (--output json)

uip platform tenants folder-outcome-billing

uip platform tenants folder-outcome-billing get

Arguments

Options

Example

Data shape (--output json)

uip platform tenants folder-outcome-billing set

Arguments

Options

Examples

Data shape (--output json)

Exit codes

Related commands

See also