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.

UiPath Government

Gerencie a governança da UiPath — políticas de AOps, políticas de acesso e pacotes de conformidade — usando a ferramenta "uip gov".

uip gov a ferramenta de governança: ele gerencia três superfície de governança distintas sob uma CLI — políticas AOps (limites de configuração do produto impostos por produtos da UiPath como o StudioX), políticas de acesso (quem/o que pode invocar um agente, fluxo ou outro recurso com agente) e pacotes de conformidade (pacotes de políticas de AOps/acesso mapeados para uma estrutura de conformidade nomeada, como ISO 42001, que pode ser alternada para um tenant em uma etapa). Instale-o com uip tools install gov ou invoque uip gov … e deixe a instalação automática ser executada. Consulte Ferramentas ( plugins ) para obter o modelo de instalação.

A ferramenta é enviada como o pacote @uipath/gov-tool e sua superfície de comando é dividida entre esta página e duas páginas irmãs devido ao seu tamanho.

Esse recurso abrange quatro páginas​

  • Esta página — conceitos e access-policy (list/get/create/update/delete/evaluate).
  • aops-policy — política de CRUD, product, license-type, template.
  • aops-policy deployment e deployed-policy — atribuem políticas a tenants/usuários/grupos e resolvem a política efetiva no runtime.
  • compliance-packs — catalog (navegação) e state (habilitar/desabilitar/cobertura por tenant).

Conceitos​

  • Políticas de AOps versus Políticas de acesso — esses são dois sistemas independentes com suas próprias APIs, formas de dados e verbos; eles não são variantes do mesmo recurso. As políticas AOps restringem a configuração do produto (por exemplo, uma política do StudioX que limita quais configurações do projeto são permitidas) e são limitadas pela herança productName/licenseType/tenant-user-group. As políticas de acesso restringem quem/o que pode invocar um recurso (por exemplo, quais atores podem invocar um determinado agente) e são avaliadas por um Ponto de Decisão de Política (PDP) em um contexto de solicitação em tempo real.
  • Os pacotes de conformidade une os dois — um pacote agrupa um conjunto de políticas AOps pré-construídas (e potencialmente políticas de acesso) mapeadas para cláusulas de uma estrutura nomeada (ISO 42001 etc.). Habilitar um pacote implanta suas políticas para Aops em uma chamada em vez de criar cada uma manualmente.
  • Dados de referência somente leitura — product, license-type e o pacote de conformidade catalog são somente leitura: eles existem para descobrir valores válidos para os comandos de transformação (--product-name, identificadores de tipo de licença, packId), não para ser editado por meio da CLI.

Resumo​

uip gov access-policy list [--limit <n>] [--offset <n>] [--filter <odata>] [--sort-by <field> asc|desc]
uip gov access-policy get <policyId>
uip gov access-policy create --file <path>
uip gov access-policy update --file <path>
uip gov access-policy delete <policyId...>
uip gov access-policy evaluate --resource-type <type> [--resource-id <id>] [--actor-identity-id <id>] [--actor-process-type <type>] [--actor-process-id <id>] [--folder-key <key>] [--trace-parent-id <id>]
uip gov access-policy list [--limit <n>] [--offset <n>] [--filter <odata>] [--sort-by <field> asc|desc]
uip gov access-policy get <policyId>
uip gov access-policy create --file <path>
uip gov access-policy update --file <path>
uip gov access-policy delete <policyId...>
uip gov access-policy evaluate --resource-type <type> [--resource-id <id>] [--actor-identity-id <id>] [--actor-process-type <type>] [--actor-process-id <id>] [--folder-key <key>] [--trace-parent-id <id>]

política de acesso do uip gov​

Gerenciar Políticas de Acesso de ponta a ponta. Dois serviços de apoio são envolvidos: o Ponto de Administração de Política (TPA) para list/get/create/update/delete em registros de política e o Ponto de Decisão de Política (PDP) para evaluate, que resolve a decisão eficaz Permitir/Negar para um contexto de solicitação concreto.

Observação:

Fluxo típico: crie um PolicyDefinition JSON → create --file ... → evaluate --resource-type <type> (com outros sinalizadores de contexto) para confirmar se a política entra em vigor → itere update --file ... com.

lista de políticas de acesso de uip gov​

Pesquise políticas com filtragem e paginação OData opcionais.

Opções​
LongValorPadrãoDescription
--limit <n>número inteiro não negativo20Tamanho da página — políticas máximas a serem retornadas.
--offset <n>número inteiro não negativo0Registros a ignorar antes da página retornada.
--filter <filter>Expressão do OData—Por exemplo, "status in ('Active')".
--sort-by <order><Field> asc|desc—por exemplo "Name asc", "CreatedOn desc".
--login-validity <minutes>número inteiro não negativo—Substitua o tempo de vida do token de login interativo para esta chamada.
Exemplo​
uip gov access-policy list --filter "status in ('Active')" --sort-by "Name asc"
uip gov access-policy list --filter "status in ('Active')" --sort-by "Name asc"
Formato dos dados (--output json)​
{
  "Code": "PolicyList",
  "Data": {
    "totalCount": 1,
    "results": [
      { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Agent Governance", "status": "Active" }
    ]
  }
}
{
  "Code": "PolicyList",
  "Data": {
    "totalCount": 1,
    "results": [
      { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Agent Governance", "status": "Active" }
    ]
  }
}

Obter política de acesso do uiip gov​

Buscar o PolicyDefinition completo para uma política por UUID — use para inspecionar seletores/regras/imposição ou para gerar um update.

Argumentos​
NameRequiredFinalidade
<policyId>simUUID da política, de access-policy list.
Exemplo​
uip gov access-policy get a1b2c3d4-0000-0000-0000-000000000001
uip gov access-policy get a1b2c3d4-0000-0000-0000-000000000001
Formato dos dados (--output json)​
{
  "Code": "PolicyGet",
  "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Agent Governance", "status": "Active" }
}
{
  "Code": "PolicyGet",
  "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Agent Governance", "status": "Active" }
}

criação da política de acesso do uip gov​

Crie uma nova política de acesso a partir de um arquivo JSON em conformidade com PolicyDefinition. Enviado como está (sem encapsulamento de envelope) — não inclua um id atribuído pelo servidor.

Opções​
LongValorRequiredDescription
--file <path>PathsimArquivo JSON contendo o PolicyDefinition a ser criado.
--login-validity <minutes>número inteiro não negativonãoSubstitua a vida útil do token de login interativo.

Um conflito de nome com uma política existente falha na chamada — verifique access-policy list primeiro.

Exemplo​
uip gov access-policy create --file ./policy.json
uip gov access-policy create --file ./policy.json
Formato dos dados (--output json)​
{
  "Code": "PolicyCreated",
  "Data": {
    "statusCode": 200,
    "errors": null,
    "upsertedPolicy": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Agent Governance", "status": "Active" }
  }
}
{
  "Code": "PolicyCreated",
  "Data": {
    "statusCode": 200,
    "errors": null,
    "upsertedPolicy": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Agent Governance", "status": "Active" }
  }
}

Capture upsertedPolicy.id para chamadas de acompanhamento evaluate/update/delete.

atualização da política de acesso de uip gov​

Atualize uma política de acesso existente a partir de um arquivo JSON. Enviado como um PATCH HTTP — o arquivo deve incluir a id da política.

Opções​
LongValorRequiredDescription
--file <path>PathsimArquivo JSON com o PolicyDefinition atualizado (deve incluir id).
--login-validity <minutes>número inteiro não negativonãoSubstitua a vida útil do token de login interativo.

Para semear o arquivo: access-policy get <id>, edite o JSON, passe-o de volta por meio de --file.

Exemplo​
uip gov access-policy update --file ./policy.json
uip gov access-policy update --file ./policy.json
Formato dos dados (--output json)​

Mesmo formato que create, com Code: "PolicyUpdated".

exclusão da política de acesso do uiip gov​

Exclua uma ou mais políticas de acesso por UUID em uma única solicitação. Permanente — não há exclusão reversível/desfazer.

Argumentos​
NameRequiredFinalidade
<policyId...>simUm ou mais UUIDs de política, separados por espaço.
Exemplo​
uip gov access-policy delete a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002
uip gov access-policy delete a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002
Formato dos dados (--output json)​
{ "Code": "PolicyDeleted", "Data": { "PolicyIds": ["a1b2c3d4-0000-0000-0000-000000000001", "a1b2c3d4-0000-0000-0000-000000000002"] } }
{ "Code": "PolicyDeleted", "Data": { "PolicyIds": ["a1b2c3d4-0000-0000-0000-000000000001", "a1b2c3d4-0000-0000-0000-000000000002"] } }

avaliação da política de acesso do uip gov​

Peça ao PDP para resolver a decisão efetiva Permitir/Negar para um contexto de solicitação — visualize o que um ator verá antes da implantação ou depure uma negação de produção. Requer contexto do tenant (o login deve ter como alvo um tenant específico, não apenas uma organização).

Opções​
LongValorRequiredDescription
--resource-type <type>um entre Agent, AgenticProcess, RPAWorkflow, APIWorkflow, CaseManagement, FlowsimO ativo protegido que está sendo acessado.
--resource-id <id>StringnãoIdentificador da instância do recurso específica (por exemplo, um UUID de agente).
--actor-identity-id <id>StringnãoIdentificador de ator — necessário apenas com um token S2S; com um token de usuário, o ator é inferido do portador.
--actor-process-type <type>um destes Agent, AgenticProcess, CaseManagement, FlownãoO fluxo de trabalho/agente sendo executado em nome do ator, se houver.
--actor-process-id <id>StringnãoIdentificador desse executável (por exemplo, um UUID de fluxo).
--folder-key <key>UUIDnãoChave de pasta que define a solicitação.
--trace-parent-id <id>StringnãoValor traceparent do W3C para correlacionar essa avaliação com rastreamentos upstream.
--login-validity <minutes>número inteiro não negativonãoSubstitua a vida útil do token de login interativo.

A falha ocorre com um "contexto do tenant" claro. erro se o cliente não puder resolver um ID de tenant do login atual.

Exemplo​
uip gov access-policy evaluate --resource-type Agent
uip gov access-policy evaluate --resource-type Agent
Formato dos dados (--output json)​
{
  "Code": "PolicyEvaluated",
  "Data": { "enforcement": "Allow", "evaluationDetails": null, "effectivePolicies": [] }
}
{
  "Code": "PolicyEvaluated",
  "Data": { "enforcement": "Allow", "evaluationDetails": null, "effectivePolicies": [] }
}

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