UiPath Documentation
uipath-cli
latest
false
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

Guía del usuario de UiPath CLI

Última actualización 22 de may. de 2026

uip platform groups

uip platform groups manages group-based license-allocation rules. A rule attaches a set of user bundles (and optional per-bundle quotas) to a directory group; members of the group automatically lease the entitled bundles. Use rules get to list every group's rule across the organization, rules details to inspect one group's rule with its member-level leases, and rules set to configure entitlements and quotas.

Sinopsis

uip platform groups rules <verb> [options] [<group>]
uip platform groups rules <verb> [options] [<group>]

Verbos

VerboPropósito
getList group license-allocation rules with quota configuration and current usage. Paginated.
detailsGet one group's rule, with the paginated list of group members and the bundles each one is leasing.
setSet (or replace) the user-bundle allocation rule and optional per-bundle quotas for a group.

Group resolution

details and set take a <group> positional argument — a name prefix. The CLI searches directory groups and requires exactly one match:

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

uip platform groups rules get

List group license-allocation rules across the organization. Each row is one (group, bundle) pair; groups with multiple entitled bundles produce one row per bundle. The response includes the group's own per-bundle quota (quota) and the current usage against that quota (currentUsage), plus a useExternalLicense flag indicating whether the group is configured to lease bundles from external licensing.

Opciones

LargoValorPredeterminadoDescripción
--limitNúmero50Maximum number of results to return.
--offsetNúmero0Number of results to skip.
--sort-byCampoField to sort by (for example, name).
--sort-orderENUMSort order: Asc or Desc.
--organizationaccount-idsesión predeterminadaOrganization account GUID. Override the org resolved from the current login.

Ejemplo

uip platform groups rules get --limit 50
uip platform groups rules get --limit 50

Forma de datos (--json de salida)

{
  "Code": "GroupRules",
  "Data": [
    {
      "groupId": "35551807-06b1-4cda-90a1-2fb84851eee7",
      "groupName": "RPA Developers",
      "code": "RPADEVPRONU",
      "name": "RPADEVPRONU",
      "quota": 25,
      "currentUsage": 12,
      "useExternalLicense": false
    }
  ]
}
{
  "Code": "GroupRules",
  "Data": [
    {
      "groupId": "35551807-06b1-4cda-90a1-2fb84851eee7",
      "groupName": "RPA Developers",
      "code": "RPADEVPRONU",
      "name": "RPADEVPRONU",
      "quota": 25,
      "currentUsage": 12,
      "useExternalLicense": false
    }
  ]
}

The response also includes pagination metadata (returned, limit, offset, total).

uip platform groups rules details

Get a group's license-allocation rule with quotas, flattened to one row per (user, bundle leased). Users with no leases yet appear as a single row with null bundle columns. The user list is paginated; use --limit and --offset to page through it. A header summary (entitled bundles, quotas as used/limit, useExternalLicense) is written to stderr so it does not interfere with the JSON data on stdout.

Argumentos

NombreObligatorioPropósito
<group>Group identifier (name prefix; must match exactly one directory group).

Opciones

LargoValorPredeterminadoDescripción
--limitNúmero50Maximum number of users to return.
--offsetNúmero0Number of users to skip.
--sort-byCampoField to sort users by (for example, name).
--sort-orderENUMUser sort order: Asc or Desc.
--organizationaccount-idsesión predeterminadaOrganization account GUID. Override the org resolved from the current login.

Ejemplo

uip platform groups rules details "RPA Developers" --limit 100
uip platform groups rules details "RPA Developers" --limit 100

Forma de datos (--json de salida)

{
  "Code": "GroupRuleDetails",
  "Data": [
    {
      "userDisplayName": "Dan Dinu",
      "email": "dan.dinu@uipath.com",
      "lastInUse": "2026-05-10T08:15:00.000Z",
      "orphan": false,
      "bundleCode": "RPADEVPRONU",
      "bundleName": "RPADEVPRONU",
      "quota": 25,
      "currentUsage": 12
    }
  ]
}
{
  "Code": "GroupRuleDetails",
  "Data": [
    {
      "userDisplayName": "Dan Dinu",
      "email": "dan.dinu@uipath.com",
      "lastInUse": "2026-05-10T08:15:00.000Z",
      "orphan": false,
      "bundleCode": "RPADEVPRONU",
      "bundleName": "RPADEVPRONU",
      "quota": 25,
      "currentUsage": 12
    }
  ]
}

uip platform groups rules set

Set the user-bundle allocation rule for a group, optionally with per-bundle quotas. Omitting quota on an entry means no quota enforcement for that bundle. The new rule replaces the group's previous bundle list — bundles not listed in --input are removed from the rule.

Argumentos

NombreObligatorioPropósito
<group>Group identifier (name prefix; must match exactly one directory group).

Opciones

LargoValorPredeterminadoDescripción
--inputRutaobligatorioPath to a JSON file with the rule, for example [{"code":"RPADEVPRONU"},{"code":"ATTUNU","quota":10}].
--organizationaccount-idsesión predeterminadaOrganization account GUID. Override the org resolved from the current login.

Ejemplo

uip platform groups rules set "RPA Developers" \
    --input ./group-rule.json
uip platform groups rules set "RPA Developers" \
    --input ./group-rule.json

group-rule.json:

[
  { "code": "RPADEVPRONU", "quota": 25 },
  { "code": "ATTUNU" }
]
[
  { "code": "RPADEVPRONU", "quota": 25 },
  { "code": "ATTUNU" }
]

Forma de datos (--json de salida)

{
  "Code": "GroupRuleSet",
  "Data": [
    { "code": "RPADEVPRONU", "name": "RPADEVPRONU", "quota": 25, "currentUsage": 12 },
    { "code": "ATTUNU",      "name": "ATTUNU",      "quota": null, "currentUsage": null }
  ]
}
{
  "Code": "GroupRuleSet",
  "Data": [
    { "code": "RPADEVPRONU", "name": "RPADEVPRONU", "quota": 25, "currentUsage": 12 },
    { "code": "ATTUNU",      "name": "ATTUNU",      "quota": null, "currentUsage": null }
  ]
}

Códigos de salida

Consulta Códigos de salida. Sin anulaciones específicas de verbos.

  • uip platform users — direct user-bundle allocation; users licenses get shows which bundles a member is leasing from each group rule.
  • uip platform tenants — tenant-level runtime and consumable allocation.

Ver también

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado