UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

usuários da plataforma uip

Sintaxe e opções para "usuários da plataforma UIP", que gerencia a alocação de pacote de licença por usuário por meio do Contador de licenças.

uip platform users gerencia a alocação de pacote de licenças por usuário por meio do Contador de licenças, além de recargas de consumíveis por usuário e relatórios de uso de licenças/consumíveis. Três grupos de comando independentes residem aqui: licenses (alocação direta/grupo de pacotes), top-ups (conceder e rastrear coberturas de consumíveis) e usage (consumimento de licenças por usuário).

Resumo

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

Verbo

GrupoTextoFinalidade
licensessetAloque licenças de pacote de usuário diretamente a um usuário de diretório.
licensesgetListe as concessões do pacote de usuário atualmente mantidas por um usuário do diretório, com a origem de cada locação.
licensesavailableObtenha o resumo no nível da conta das licenças de pacote do usuário (total, alocada, disponível).
top-upscreateConceda uma proteção a um usuário do pool de consumíveis ativo da organização.
top-upsgetVerifique o status de um trabalho de concessão de complemento.
top-upsrequestSolicitar uma completa para você mesmo; notifica os administradores da organização.
usagelistListe os usuários com consumo de licenças na organização.
usagegetMostrar o consumo de licença por usuário (seu próprio ou um administrador visualizando o de outro usuário).

Resolução do usuário

set e get aceitam um argumento posicional <user> — um nome ou prefixo de e-mail. A CLI pesquisa usuários locais e de diretório com uma correspondência "começa com" e requer exatamente uma correspondência:

  • Nenhuma correspondência → erro com "No directory user found matching '<input>'.".
  • Várias correspondências → erro lista até 10 candidatos para que você possa refinar a entrada.

conjunto de licenças de usuários da plataforma uip

Aloque licenças de pacote de usuário a um usuário de diretório. Os pacotes em --input substituem os pacotes alocados diretamente do usuário; os pacotes herdados das regras de grupo não são afetados por esse comando.

Argumentos

NameRequiredFinalidade
<user>simIdentificador do usuário (nome ou prefixo do e-mail; deve corresponder exatamente a um usuário do diretório).

Opções

LongValorPadrãoDescription
--inputPathnecessárioCaminho para um arquivo JSON com a alocação de licenças de usuário desejada, por [{"code":"RPADEVPRONU"},{"code":"ATTUNU"},{"code":"TSTNU"}].
--organizationID da contapadrão da sessãoGUID da conta da organização. Substitua a organização resolvida a partir do login atual.

Exemplo

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

Formato dos dados (--output json)

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

licenças de usuários da plataforma uip obter

Obtenha as licenças de pacote de usuário atualmente concedidas por um usuário de diretório. Cada linha é um pacote tenant; source é "group" quando a locação é herdada de uma regra de grupo ou "direct" para alocações fora de grupo.

Argumentos

NameRequiredFinalidade
<user>simIdentificador do usuário (nome ou prefixo do e-mail; deve corresponder exatamente a um usuário do diretório).

Opções

LongValorPadrãoDescription
--organizationID da contapadrão da sessãoGUID da conta da organização. Substitua a organização resolvida a partir do login atual.

Exemplo

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

Formato dos dados (--output json)

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

licenças de usuários da plataforma uip disponíveis

Obtenha o resumo no nível da conta das licenças de pacote do usuário: quantas estações por pacote existem (total), quantas já estão alocadas (allocated) e quantas permanecem disponíveis (available). Use isso antes de alocar para confirmar a capacidade.

Opções

LongValorPadrãoDescription
--organizationID da contapadrão da sessãoGUID da conta da organização. Substitua a organização resolvida a partir do login atual.

Exemplo

uip platform users licenses available
uip platform users licenses available

Formato dos dados (--output json)

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

recarregamentos de usuários da plataforma uip

Conceda e rastreie compras de consumíveis por usuário. O pool de origem é resolvido automaticamente a partir dos consumíveis ativos da organização (PLTU preferido, caso contrário, AGU) — você nunca passa o pool explicitamente.

usuários da plataforma uip criar recarregamentos criar

Conceda uma atualização a um usuário.

Argumentos
NameRequiredFinalidade
<user>simIdentificador do usuário (nome ou prefixo do e-mail; deve corresponder exatamente a um usuário do diretório).
Opções
LongValorPadrãoDescription
--waitBandeiradesativadaAguarde até que o trabalho de carregamento seja concluído e relate se ele foi concedido.
--countnúmero inteiro (1-100)1Número de unidades de adição a serem concedidas.
--organizationID da contapadrão da sessãoGUID da conta da organização.
Exemplos
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
Formato dos dados (--output json)

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

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

as melhorias de usuários da plataforma uip obter

Verifique o status de um trabalho de concessão de complemento.

Argumentos
NameRequiredFinalidade
<job-id>simID do trabalho de preenchimento retornado por top-ups create.
Opções
LongValorPadrãoDescription
--organizationID da contapadrão da sessãoGUID da conta da organização.
Exemplo
uip platform users top-ups get b3f1c2d4-0000-0000-0000-000000000009
uip platform users top-ups get b3f1c2d4-0000-0000-0000-000000000009
Formato dos dados (--output json)
{
  "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
  }
}

solicitação de recargas de usuários da plataforma uip

Solicite uma atualização para você (o usuário conectado). Isso notifica os administradores da sua organização — não concede nada diretamente.

Opções
LongValorPadrãoDescription
--organizationID da contapadrão da sessãoGUID da conta da organização.
Exemplo
uip platform users top-ups request
uip platform users top-ups request
Formato dos dados (--output json)
{
  "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."
  }
}

Um resultado nãoNotificationSent (por exemplo, NotEligible ou NoActiveDistribution) é retornado como uma falha com a mensagem do servidor.

uso dos usuários da plataforma uip

Visualização do consumo de licença por usuário: porcentagem de consumo mensal do pool e porcentagem de consumo da carteira de carregamento.

lista de uso de usuários da plataforma uip

Liste os usuários com consumo de licenças na organização.

Opções
LongValorPadrãoDescription
--limitNúmero inteirotamanho de página padrãoNúmero máximo de usuários a serem retornados.
--offsetNúmero inteiro0Número de usuários a ignorar.
--sort-byCampoClassificar por um campo da linha de uso do usuário (por exemplo, email, displayName).
--sort-orderascdesc
--license-codescódigos separados por espaçoFiltre para usuários que possuem pacotes de licenças específicos (por exemplo, RPADEVPRONU ATTUNU).
--organizationID da contapadrão da sessãoGUID da conta da organização.
Exemplos
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
Formato dos dados (--output json)
{
  "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 é null 0(não) quando o usuário não tem permissão mensal. status é um de MonthlyLimit, TopUp, PaidUnits.

uso dos usuários da plataforma uip obter

Mostre o consumo de licença por usuário: a porcentagem mensal de cada consumível consumida, a data de redefinição, o detalhamento por serviço e a carteira de carregamento quando presente.

Argumentos
NameRequiredFinalidade
[user]nãoIdentificador do usuário (nome ou prefixo do e-mail). Omita para mostrar o uso do próprio usuário conectado; passe um (caminho do admin) para ver o de outro usuário.
Opções
LongValorPadrãoDescription
--organizationID da contapadrão da sessãoGUID da conta da organização.
Exemplos
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"
Formato dos dados (--output json)
{
  "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 saída

Consulte Códigos de saída. Nenhuma substituição específica do verbo.

  • uip platform groups — regras de grupo que alugam pacotes para muitos usuários de uma só vez (esses aparecem com source: "group" em users licenses get).
  • uip platform tenants — o runtime no nível do tenant e a alocação de consumíveis.

Veja também

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades