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.

Grupos da plataforma UIP

Sintaxe e opções para "grupos de plataforma uip", que gerencia regras de alocação de licenças baseadas em grupos para pacotes de usuários.

uip platform groups gerencia regras de alocação de licenças baseadas em grupos. Uma regra anexa um conjunto de pacotes de usuários (e cotas opcionais por pacote) a um grupo de diretórios; os membros do grupo tenantm automaticamente os pacotes com direito. Use rules get para listar a regra de todos os grupos em toda a organização, rules details para inspecionar a regra de um grupo com suas locação no nível do membro e rules set para configurar direitos e cotas.

Resumo​

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

Verbo​

TextoFinalidade
getListe as regras de alocação de licença de grupo com a configuração de cota e o uso atual. Paginado.
detailsObtenha a regra de um grupo, com a lista paginada de membros do grupo e os pacotes que cada um está concedendo.
setDefina (ou substitua) a regra de alocação de pacote de usuário e cotas opcionais por pacote para um grupo.

Resolução de grupo​

details e set aceitam um argumento posicional <group> — um prefixo de nome. A CLI pesquisa grupos de diretórios e requer exatamente uma correspondência:

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

obtenção de regras de grupos de plataforma uip​

Liste as regras de alocação de licenças de grupo na organização. Cada linha é um par (group, bundle) ; grupos com vários pacotes com direito produzem uma linha por pacote. A resposta inclui a própria cota por pacote do grupo (quota) e o uso atual em relação a essa cota (currentUsage), além de um sinalizador useExternalLicense que indica se o grupo está configurado para alocar pacotes de licenciamento externo.

Opções​

LongValorPadrãoDescription
--limitNúmero50Número máximo de resultados a serem retornados.
--offsetNúmero0Número de resultados a serem ignorados.
--sort-byCampo—Campo usado na classificação. Valores aceitos: Id, GlobalId, GroupId, OrganizationId, UseExternalLicense, UserBundleCodesAsJson, UserBundleCodes. Qualquer outra coisa retorna HTTP 400 — por exemplo, name não é aceito.
--sort-orderENUM—Ordem de classificação: Asc ou Desc.
--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 groups rules get --limit 50
uip platform groups rules get --sort-by GroupId --sort-order Asc
uip platform groups rules get --limit 50
uip platform groups rules get --sort-by GroupId --sort-order Asc

Formato dos dados (--output json)​

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

A resposta também inclui metadados de paginação (retornado, limite, deslocamento, total).

detalhes das regras dos grupos de plataforma uip​

Obtenha a regra de alocação de licenças de um grupo com cotas, mesclada a uma linha por (user, bundle leased). Usuários sem tenants ainda aparecem como uma única linha com colunas de pacote nulas. A lista de usuários é paginada; use --limit e --offset para paginar por ele. Um resumo de cabeçalho (pacotes com direito, cotas como used/limit, useExternalLicense) é gravado no stderr para não interferir com os dados JSON no stdout.

Argumentos​

NameRequiredFinalidade
<group>simIdentificador do grupo (prefixo do nome; deve corresponder exatamente a um grupo do diretório).

Opções​

LongValorPadrãoDescription
--limitNúmero50Número máximo de usuários a serem retornados.
--offsetNúmero0Número de usuários a ignorar.
--sort-byCampo—Campo usado para classificar usuários. Validado no lado do servidor pelo Contador de licenças; um campo não compatível retorna HTTP 400. A lista de campos aceitos não é enumerada na origem da CLI para esse ponto de extremidade (ao contrário de rules get) — verifique a resposta da API se um palpite for rejeitado.
--sort-orderENUM—Ordem de classificação do usuário: Asc ou Desc.
--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 groups rules details "RPA Developers" --limit 100
uip platform groups rules details "RPA Developers" --limit 100

Formato dos dados (--output json)​

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

A resposta também inclui metadados de paginação (retornado, limite, deslocamento, total) sobre a lista de usuários, exatamente rules get como.

conjunto de regras de grupos de plataforma uip​

Defina a regra de alocação de pacote de usuário para um grupo, opcionalmente com cotas por pacote. Omitir quota em uma entrada significa que não há aplicação de cota para esse pacote. A nova regra substitui a lista de pacotes anterior do grupo — os pacotes não listados em --input são removidos da regra.

Argumentos​

NameRequiredFinalidade
<group>simIdentificador do grupo (prefixo do nome; deve corresponder exatamente a um grupo do diretório).

Opções​

LongValorPadrãoDescription
--inputPathnecessárioCaminho para um arquivo JSON com a regra, por exemplo, [{"code":"RPADEVPRONU"},{"code":"ATTUNU","quota":10}].
--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 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" }
]

Formato dos dados (--output json)​

{
  "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 saída​

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

  • uip platform users — alocação direta de pacote de usuário; users licenses get mostra quais pacotes um membro está locação de cada regra de grupo.
  • 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