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 gestiona la asignación de paquetes de licencias por usuario a través del Contador de licencias, además de las recargas de consumibles por usuario y los informes de uso de licencias/consumibles. Aquí hay tres grupos de comandos independientes: licenses (asignación de paquetes directa/de grupo), top-ups (conceder y realizar un seguimiento de las recargas de consumibles) y usage (consumo de licencias por usuario).

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-upscreateConcede una recarga a un usuario del grupo de consumibles activo de la organización.
top-upsgetComprobar el estado de un trabajo de concesión de recarga.
top-upsrequestSolicitar una recarga para ti; notifica a los administradores de la organización.
usagelistEnumerar usuarios con consumo de licencias en la organización.
usagegetMostrar el consumo de licencias por usuario (el tuyo o un administrador que vea el de otro usuario).

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>Sí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>Sí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 }
  ]
}

Recargas de usuarios de la plataforma UIP​

Otorga y realiza un seguimiento de las recargas de consumibles por usuario. El grupo de origen se resuelve automáticamente a partir de los consumibles activos de la organización (PLTU preferido, de lo contrario AGU): nunca pasas el grupo explícitamente.

creación de recargas de usuarios de la plataforma uip​

Conceder una recarga a un usuario.

Argumentos​
NombreObligatorioPropósito
<user>SíIdentificador de usuario (nombre o prefijo de correo electrónico; debe coincidir exactamente con un usuario del directorio).
Opciones​
LargoValorPredeterminadoDescripción
--waitMarcaDesactivadoEspere hasta que finalice el trabajo de recarga e informe si se concedió.
--countentero (1-100)1Número de unidades de recarga que se otorgarán.
--organizationID de cuentasesión predeterminadaGUID de la cuenta de la organización.
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
  }
}

Obtener recargas de usuarios de la plataforma uip​

Comprobar el estado de un trabajo de concesión de recarga.

Argumentos​
NombreObligatorioPropósito
<job-id>SíID de trabajo de recarga devuelto por top-ups create.
Opciones​
LargoValorPredeterminadoDescripción
--organizationID de cuentasesión predeterminadaGUID de la cuenta de la organización.
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
  }
}

Solicitud de recarga de usuarios de la plataforma UIP​

Solicita una recarga para ti (el usuario que ha iniciado sesión). Esto notifica a los administradores de tu organización: no otorga nada directamente.

Opciones​
LargoValorPredeterminadoDescripción
--organizationID de cuentasesión predeterminadaGUID de la cuenta de la organización.
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."
  }
}

Un resultado noNotificationSent (por ejemplo NotEligible o NoActiveDistribution) se devuelve como un error con el mensaje del servidor.

Uso de los usuarios de la plataforma UIP​

Ver el consumo de licencias por usuario: porcentaje consumido del grupo mensual y porcentaje consumido de la cartera de recarga.

Lista de uso de usuarios de la plataforma UIP​

Enumerar usuarios con consumo de licencias en la organización.

Opciones​
LargoValorPredeterminadoDescripción
--limitEnterotamaño de página predeterminadoNúmero máximo de usuarios para devolver.
--offsetEntero0Número de usuarios que se omitirán.
--sort-byCampo—Ordenar por un campo de la fila de uso del usuario (por ejemplo, email, displayName).
--sort-orderascdesc—
--license-codescódigos separados por espacios—Filtrar a usuarios que tengan paquetes de licencias específicos (por ejemplo, RPADEVPRONU ATTUNU).
--organizationID de cuentasesión predeterminadaGUID de la cuenta de la organización.
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 es null (no 0) cuando el usuario no tiene asignación mensual. status es uno de MonthlyLimit, TopUp, PaidUnits.

uso de los usuarios de la plataforma uip get​

Mostrar consumo de licencias por usuario: el porcentaje mensual consumido de cada consumible, la fecha de restablecimiento, el desglose por servicio y la cartera de recarga cuando esté presente.

Argumentos​
NombreObligatorioPropósito
[user]NoIdentificador de usuario (nombre o prefijo de correo electrónico). Omitir para mostrar el uso propio del usuario que ha iniciado sesión; pase uno (ruta de administrador) para ver la de otro usuario.
Opciones​
LargoValorPredeterminadoDescripción
--organizationID de cuentasesión predeterminadaGUID de la cuenta de la organización.
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