- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip model-hub
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-library-object-repository
- get-object-repository
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-instances
- list-workflow-examples
- pack
- publish
- remote
- restore
- run, debug & execution
- run-file
- search-templates
- start-studio
- stop-execution
- tm
- uia
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
Manage organization- and tenant-level license resources using the `uip platform` tool, covering tenant allocations, user bundles, and group rules.
uip platform is the Platform tool: it manages organization- and tenant-level license resources — tenant runtime/consumable allocations, per-user license bundles, group allocation rules, and the organization-wide consumables report. Install it with uip tools install platform, or invoke uip platform … and let auto-install run. See Tools (plugins) for the install model and uip tools for the command that manages tool installation.
Resources
Each resource has its own reference page. The verb set on each page matches the commands registered by uip platform — run uip platform --help to confirm the full surface on your installation.
| Resource | Purpose |
|---|---|
| tenants | Get the license summary for a tenant; set runtime licenses and consumables, routed to the service license that already owns each product code; get/set per-folder outcome billing. |
| users | Allocate user-bundle licenses to a directory user, list a user's current leases (direct or group-inherited), view account-level user-bundle availability, grant/track consumable top-ups, and report per-user license usage. |
| groups | List, inspect, and configure group license-allocation rules with optional per-bundle quotas. |
| licenses | Organization-level consumables reporting: per-tenant allocation summary, daily breakdown by service, and per-folder breakdown. |
Synopsis
uip platform <resource> <verb> [options]
uip platform <resource> <verb> [options]
Always uip platform, never uip plt. platform is the tool's command prefix (see the commandPrefix column in uip tools list).
How to read this section
Every resource page is structured the same way:
- Synopsis — the
uip platform <resource> <verb>command shape. - Verbs — a one-line table of every verb the resource exposes.
- One H2 per verb — description, positional arguments (if any), flag table, an example, and the
Datashape returned under--output json. - Exit codes — a pointer to the shared Exit codes contract.
- Related commands and See also — cross-links to sibling resources and relevant concept pages.
Default output format is --output json. Data shapes on every page reflect the JSON payload — table, yaml, and plain renderings are derived from the same Data object.
Common flags
Most uip platform verbs share one optional org-scoping flag. Identifier flags (<tenant-key>, <user>, <group>) are positional and documented per verb.
| Flag | Used by | Purpose |
|---|---|---|
--organization <account-id> | most verbs | Organization account GUID. Defaults to the org from the current login. Override when an external app or session is scoped to a different account. Exception: uip platform licenses consumables get registers no --organization option at all. |
Verb-level flags (--input, --mode, --tenant, --unit, --start-date, --end-date, --limit, --offset, --sort-by, --sort-order) are documented on each resource page.
Global options and exit codes
All uip platform verbs honor the four global options (--output, --output-filter, --log-level, --log-file). Exit codes follow the shared contract.
See also
- Concepts: how UiPath CLI is organized — where tools fit in the host + tool model.
- Sessions — how the organization context is resolved.
- Configuration — environment variables and config files that affect every tool.
- uip or licenses — Orchestrator-level robot license assignment (machine and named-user), complementary to platform-level allocation.