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.

auditoria de administrador da UIP

Sintaxe e opções para "uip admin audit", que consulta e exporta eventos de auditoria de administração da UiPath no escopo da organização e do tenant.

uip admin audit consulta e exporta eventos de auditoria da UiPath — a trilha de auditoria do administrador no nível da plataforma (diferente de uip or audit-logs, que abrange alterações da entidade do Orchestrator). Parte de uip admin (visão geral), a ferramenta de administração da UiPath.

Dois subgrupos de escopo registram a forma idêntica de três verbos:

  • org auditoria com escopo de organização (eventos de administrador que são agnósticos de tenant).
  • tenant auditoria com escopo de tenant (eventos com escopo no tenant de login ativo ou --tenant-id).

Fluxo de trabalho típico: audit <scope> sources (descobrir IDs de origem) → audit <scope> events --source <guid> --from-date … --to-date … (encontrar as linhas) → audit <scope> export --from-date … --to-date … --output-path … (Baixá-las).

Resumo​

uip admin audit org sources [--login-validity <minutes>]
uip admin audit org events [--from-date <iso>] [--to-date <iso>] [--source <guid>...] [--target <guid>...] [--type <guid>...] [--user-id <guid>...] [--search <term>] [--status Success|Failure] [--limit <n>]
uip admin audit org export --from-date <iso> --to-date <iso> --output-path <dir> [--file-format json|csv]

uip admin audit tenant sources [--tenant-id <guid>] [--login-validity <minutes>]
uip admin audit tenant events [--tenant-id <guid>] [... same filters as org events]
uip admin audit tenant export [--tenant-id <guid>] --from-date <iso> --to-date <iso> --output-path <dir> [--file-format json|csv]
uip admin audit org sources [--login-validity <minutes>]
uip admin audit org events [--from-date <iso>] [--to-date <iso>] [--source <guid>...] [--target <guid>...] [--type <guid>...] [--user-id <guid>...] [--search <term>] [--status Success|Failure] [--limit <n>]
uip admin audit org export --from-date <iso> --to-date <iso> --output-path <dir> [--file-format json|csv]

uip admin audit tenant sources [--tenant-id <guid>] [--login-validity <minutes>]
uip admin audit tenant events [--tenant-id <guid>] [... same filters as org events]
uip admin audit tenant export [--tenant-id <guid>] --from-date <iso> --to-date <iso> --output-path <dir> [--file-format json|csv]

os verbos tenant também aceitam --tenant-id <guid> para substituir o tenant de seu contexto de login; os verbos org não (o escopo da organização não tem tenant para substituir).

origens da organização de auditoria do administrador uip / origens de tenant de auditoria do administrador uip​

Liste as fontes de eventos de auditoria visíveis nesse escopo — cada origem é uma categoria de evento de nível superior (por exemplo, Identity, Tenant, Robot). Use os valores id retornados com events --source <guid>.

Opções​

LongValorDescription
--tenant-id <guid>GUID(Apenas para escopo tenant .) Substitui o tenant do contexto de login.
--login-validity <minutes>Número inteiroSubstitua o tempo de vida do token de login interativo para esta chamada. Raramente necessário.

Exemplo​

uip admin audit org sources
uip admin audit org sources

Formato dos dados (--output json)​

{
  "Code": "AuditOrgSources",
  "Data": [
    { "id": "11111111-1111-1111-1111-111111111111", "name": "Identity", "eventTargets": [] }
  ]
}
{
  "Code": "AuditOrgSources",
  "Data": [
    { "id": "11111111-1111-1111-1111-111111111111", "name": "Identity", "eventTargets": [] }
  ]
}

Code é AuditTenantSources em tenant.

Eventos da organização de auditoria do administrador uip / eventos de tenant de auditoria do administrador uip​

Eventos de auditoria de consulta neste escopo, paginados. Retorna { auditEvents, next, previous } — não um array simples. A nomeação do cursor é cronológica: next são eventos mais recentes, previous é mais antigo. Quando --limit excede 200, a CLI pagina internamente (seguindo previous), pois o servidor limita cada chamada a 200 linhas.

Opções​

LongValorDescription
--from-date <iso>ISO 8601Início do intervalo de tempo. Inclusivo.
--to-date <iso>ISO 8601Fim do intervalo de tempo. Inclusivo.
--source <guid>GUID, repetívelFiltrar por IDs de origem do evento. Descubra com sources.
--target <guid>GUID, repetívelFiltrar por IDs de destino de evento.
--type <guid>GUID, repetívelFiltrar por IDs de tipo de evento.
--user-id <guid>GUID, repetívelFiltrar por IDs de usuário de agente.
--search <term>StringPesquisa de substring no lado do servidor.
--status <status>Success | FailureFiltro de status do evento que não diferencia maiúsculas de minúsculas.
--limit <n>Número inteiroTotal de eventos a serem retornados, 1–10000. Valores acima de 200 são paginados no lado do cliente (o servidor limita cada chamada a 200).
--tenant-id <guid>GUID(Apenas para escopo tenant .) Substitui o tenant do contexto de login.
--login-validity <minutes>Número inteiroSubstitua o tempo de vida do token de login interativo para esta chamada. Raramente necessário.

Exemplos​

# Fetch the latest 50 org audit events
uip admin audit org events --limit 50
# Fetch the latest 50 org audit events
uip admin audit org events --limit 50
# Filter by source and a 7-day window
uip admin audit tenant events --source 11111111-1111-1111-1111-111111111111 \
  --from-date 2026-04-22T00:00:00Z --to-date 2026-04-29T00:00:00Z
# Filter by source and a 7-day window
uip admin audit tenant events --source 11111111-1111-1111-1111-111111111111 \
  --from-date 2026-04-22T00:00:00Z --to-date 2026-04-29T00:00:00Z

Formato dos dados (--output json)​

{
  "Code": "AuditOrgEvents",
  "Data": { "auditEvents": [], "next": null, "previous": null }
}
{
  "Code": "AuditOrgEvents",
  "Data": { "auditEvents": [], "next": null, "previous": null }
}

Code é AuditTenantEvents em tenant.

exportação do org de auditoria do administrador do uip / exportação do tenant de auditoria do administrador do uip​

Exportar eventos de auditoria do armazenamento de longo prazo. Faz uma chamada HTTP por dia UTC dentro de [--from-date, --to-date] e agrega os resultados na memória antes de escrever qualquer coisa — a janela completa é buscada primeiro e, em qualquer dia de falha, a exportação é anulada atomicamente ( nada é escrito; a falha nomeia o dia em que falhou).

é um diretório base --output-path não um caminho de arquivo — passe uma pasta e a CLI gera uma saída com nome exclusivo dentro dela, carimbo com a janela e o tempo de geração (por exemplo audit_2026-01-01_2026-02-01_20260617T112630), para que exportações repetidas da mesma janela nunca colidem:

  • --file-format json (padrão) — uma pasta de um arquivo JSON por dia UTC.
  • --file-format csv — um único arquivo CSV com cada evento mesclado sob um cabeçalho compartilhado.

Opções​

LongValorRequiredDescription
--from-date <iso>ISO 8601simInício do intervalo de tempo.
--to-date <iso>ISO 8601simFim do intervalo de tempo.
--output-path <dir>PathcondicionalmenteDiretório base para a exportação (criado se ausente). Passe apenas um diretório, nunca um nome de arquivo — a CLI nomeia a saída para você. Obrigatório, a menos que --output-file (alias obsoleto) seja passado.
--output-file <dir>PathnãoAlias obsoleto para --output-path, mantido para compatibilidade com versões anteriores. Apesar do nome, ainda é tratado como um diretório base. Quando ambos são aprovados, --output-path prevalece e um aviso de descontinuação é registrado.
--file-format <format>json | csvnãoFormato de saída. jsonPadrão.
--tenant-id <guid>GUIDnão(Apenas para escopo tenant .) Substitui o tenant do contexto de login.
--login-validity <minutes>Número inteironãoSubstitua o tempo de vida do token de login interativo para esta chamada. Raramente necessário.

Exemplos​

# JSON export — a timestamped folder of day-wise JSON files is created under the base dir
uip admin audit org export --from-date 2026-01-01 --to-date 2026-02-01 --output-path ./audit-exports
# JSON export — a timestamped folder of day-wise JSON files is created under the base dir
uip admin audit org export --from-date 2026-01-01 --to-date 2026-02-01 --output-path ./audit-exports
# CSV export — a single uniquely-named .csv file under the base dir
uip admin audit tenant export --from-date 2026-01-01 --to-date 2026-02-01 \
  --file-format csv --output-path ./audit-exports
# CSV export — a single uniquely-named .csv file under the base dir
uip admin audit tenant export --from-date 2026-01-01 --to-date 2026-02-01 \
  --file-format csv --output-path ./audit-exports

Formato dos dados (--output json)​

Formato JSON:

{
  "Code": "AuditOrgExport",
  "Data": {
    "Path": "./audit-exports/audit_2026-01-01_2026-02-01_20260617T112630",
    "Format": "json",
    "Files": 27,
    "Bytes": 12345,
    "Days": 31,
    "NonEmptyDays": 27,
    "GeneratedAt": "2026-06-17T11:26:30.000Z"
  }
}
{
  "Code": "AuditOrgExport",
  "Data": {
    "Path": "./audit-exports/audit_2026-01-01_2026-02-01_20260617T112630",
    "Format": "json",
    "Files": 27,
    "Bytes": 12345,
    "Days": 31,
    "NonEmptyDays": 27,
    "GeneratedAt": "2026-06-17T11:26:30.000Z"
  }
}

O formato CSV adiciona uma contagem de Events no lugar de Files:

{
  "Code": "AuditOrgExport",
  "Data": {
    "Path": "./audit-exports/audit_2026-01-01_2026-02-01_20260617T112630.csv",
    "Format": "csv",
    "Bytes": 98765,
    "Days": 31,
    "NonEmptyDays": 27,
    "Events": 1234,
    "GeneratedAt": "2026-06-17T11:26:30.000Z"
  }
}
{
  "Code": "AuditOrgExport",
  "Data": {
    "Path": "./audit-exports/audit_2026-01-01_2026-02-01_20260617T112630.csv",
    "Format": "csv",
    "Bytes": 98765,
    "Days": 31,
    "NonEmptyDays": 27,
    "Events": 1234,
    "GeneratedAt": "2026-06-17T11:26:30.000Z"
  }
}

Code é AuditTenantExport em tenant.

Solução de problemas​

  • HTTP 401 — o token provavelmente não tem o escopo Audit.Read . Execute uip logout && uip login para criar um token novo.
  • HTTP 403 o usuário conectado não tem permissão de leitura de auditoria neste tenant; verificar atribuições de função no Automation Cloud.
  • Tenant ID required (escopo do tenant) — passe --tenant-id <guid> ou faça login e selecione um tenant primeiro.
  • HTTP 504 na exportação ou "Falha na exportação de auditoria de <date>" — a parte de um único dia expirou. Executar novamente — a exportação é idempotente. Se o problema persistir, restrinja --from-date/--to-date para pular o dia com falha.
  • "resolve fora da pasta de saída" / nome do arquivo inseguro na exportação — indica uma resposta do servidor malformada; execute novamente e relatar se ele persiste.
  • uip admin — visão geral de toda a ferramenta uip admin .
  • uip or audit-logs — a trilha de auditoria da entidade do Orchestrator, uma superfície distinta dessa auditoria no nível do administrador.

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