UiPath Documentation
uipath-cli
latest
false
Guía del usuario de UiPath CLI
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.

usuarios de la plataforma uip

Sintaxis y opciones para "usuarios de la plataforma UIP", que gestiona la asignación de paquetes de licencias por usuario a través del Contador de licencias.

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

Sinopsis

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

Verbos

GrupoVerboPropósito
licensessetAsigna licencias de paquete de usuario directamente a un usuario de directorio.
licensesgetEnumera las concesiones de paquetes de usuario que tiene actualmente un usuario del directorio, con el origen de cada concesión.
licensesavailableObtén el resumen a nivel de cuenta de las licencias de paquete de usuario (totales, asignadas, disponibles).
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).

Resolución de usuario

set y get toman un argumento posicional <user> : un nombre o prefijo de correo electrónico. El CLI busca usuarios locales y de directorio con una coincidencia "comienza con" y requiere exactamente una coincidencia:

  • No hay coincidencia → error con "No directory user found matching '<input>'.".
  • Coincidencias múltiples → error al enumerar hasta 10 candidatos para que pueda refinar la entrada.

conjunto de licencias de usuarios de la plataforma uip

Asigna licencias de paquete de usuario a un usuario de directorio. Los paquetes en --input reemplazan los paquetes asignados directamente del usuario; los paquetes heredados de las reglas de grupo no se ven afectados por este comando.

Argumentos

NombreObligatorioPropósito
<user>Identificador de usuario (nombre o prefijo de correo electrónico; debe coincidir exactamente con un usuario del directorio).

Opciones

LargoValorPredeterminadoDescripción
--inputRutaobligatorioRuta a un archivo JSON con la asignación de licencias de usuario deseada, por ejemplo [{"code":"RPADEVPRONU"},{"code":"ATTUNU"},{"code":"TSTNU"}].
--organizationID de cuentasesión predeterminadaGUID de la cuenta de la organización. Anular la organización resuelta desde el inicio de sesión actual.

Ejemplo

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

Forma de datos (--json de salida)

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

licencias de usuarios de la plataforma uip obtener

Obtener las licencias de paquete de usuario actualmente alquiladas por un usuario de directorio. Cada fila es un paquete alquilado; source es "group" cuando la concesión se hereda de una regla de grupo, o "direct" para asignaciones no grupales.

Argumentos

NombreObligatorioPropósito
<user>Identificador de usuario (nombre o prefijo de correo electrónico; debe coincidir exactamente con un usuario del directorio).

Opciones

LargoValorPredeterminadoDescripción
--organizationID de cuentasesión predeterminadaGUID de la cuenta de la organización. Anular la organización resuelta desde el inicio de sesión actual.

Ejemplo

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

Forma de datos (--json de salida)

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

licencias de usuarios de la plataforma uip disponibles

Obtén el resumen a nivel de cuenta de las licencias de paquete de usuario: cuántos puestos existen por paquete (total), cuántos ya están asignados (allocated) y cuántos quedan disponibles (available). Úselo antes de asignar para confirmar la capacidad.

Opciones

LargoValorPredeterminadoDescripción
--organizationID de cuentasesión predeterminadaGUID de la cuenta de la organización. Anular la organización resuelta desde el inicio de sesión actual.

Ejemplo

uip platform users licenses available
uip platform users licenses available

Forma de datos (--json de salida)

{
  "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.

Argumentos
NombreObligatorioPropósito
<user>Identificador de usuario (nombre o prefijo de correo electrónico; debe coincidir exactamente con un usuario del directorio).
Opciones
LargoValorPredeterminadoDescripción
--waitMarcaDesactivadoWait until the top-up job finishes and report whether it was granted.
--countinteger (1-100)1Number of top-up units to grant.
--organizationID de cuentasesión predeterminadaOrganization account GUID.
Ejemplos
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
Forma de datos (--json de salida)

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

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

Argumentos
NombreObligatorioPropósito
<job-id>Top-up job id returned by top-ups create.
Opciones
LargoValorPredeterminadoDescripción
--organizationID de cuentasesión predeterminadaOrganization account GUID.
Ejemplo
uip platform users top-ups get b3f1c2d4-0000-0000-0000-000000000009
uip platform users top-ups get b3f1c2d4-0000-0000-0000-000000000009
Forma de datos (--json de salida)
{
  "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.

Opciones
LargoValorPredeterminadoDescripción
--organizationID de cuentasesión predeterminadaOrganization account GUID.
Ejemplo
uip platform users top-ups request
uip platform users top-ups request
Forma de datos (--json de salida)
{
  "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.

Opciones
LargoValorPredeterminadoDescripción
--limitEnterodefault page sizeNúmero máximo de usuarios para devolver.
--offsetEntero0Número de usuarios que se omitirán.
--sort-byCampoSort 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).
--organizationID de cuentasesión predeterminadaOrganization account GUID.
Ejemplos
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
Forma de datos (--json de salida)
{
  "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.

Argumentos
NombreObligatorioPropósito
[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.
Opciones
LargoValorPredeterminadoDescripción
--organizationID de cuentasesión predeterminadaOrganization account GUID.
Ejemplos
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"
Forma de datos (--json de salida)
{
  "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 }
          ]
        }
      }
    ]
  }
}

Códigos de salida

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

  • uip platform groups : reglas de grupo que arriendan paquetes a muchos usuarios a la vez (aparecen con source: "group" en users licenses get).
  • uip platform tenants — runtime en el nivel de tenant y asignación de consumibles.

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