UIP ah

Gerencie ideias de automação, pipeline, taxonomia, marketplace e usuários do Automation Hub usando a ferramenta "uip ah".

uip ah é a ferramenta do Automation Hub (prefixo ah de comando,@uipath/automation-hub-tool pacote): gerencia o pipeline de ideias de automação — ideias enviadas por meio de uma avaliação, movidas por fases configuráveis, pontuadas e rastreadas até a entrega — além da taxonomia , colaboração e superfície do Marketplace ao redor. Instale-o com uip tools install ah ou invoque uip ah … e deixe a instalação automática ser executada. Consulte Ferramentas ( plugins ) para obter o modelo de instalação.

Conceitos

• Cada gravação é uma substituição de registro completo, não um patch. automations update, categories update, users update e tags set enviam a forma de registro completa do Automation Hub — os campos que você não transmite são carregados do que já está armazenado (ou, para categories update/tags set, o a coleção inteira é substituída imediatamente). Verifique as próprias notas de cada verbo para saber exatamente o que é preservado versus substituído.
• --all-fields cada comando de leitura. Um registro bruto do Automation Hub carrega cerca de 300 chaves, incluindo uma dupla __display pré-formatada para a maioria delas. Cada comando list/get projeta um campo gerenciável definido por padrão; passe --all-fields para a carga útil intacta.
• Pontos de extremidade paginados versus não paginados. A maioria dos comandos list atinge um ponto de extremidade do Automation Hub paginado e aceita --limit/--offset normalmente. Alguns pontos de extremidade (roles, idea-flows, questionnaires list, audit-logs list, collaborators list) retornam sua coleção inteira em uma chamada sem paginação no lado do servidor — --limit/--offset são aplicados no lado do cliente nestes, após o conjunto completo ser buscado.
• Os IDs vêm de outros comandos list , não da interface gráfica. A interface gráfica da Web do Automation Hub não expõe a maioria dos IDs numéricos que essa CLI aceita (IDs de categoria, IDs de status de fase, IDs de função) — encontre-os com o comando list --all-fields correspondente, como as próprias mensagens de erro de cada verbo indicam.
• Erros específicos para essa ferramenta: um 403 significa "não visível para sua função do Automation Hub", nunca "não encontrado" — o Automation Hub não usa 404 para registros fora do escopo. Um "Automation Hub" de 500 classes não está provisionado neste tenant" ou "ainda nenhum registro de tenant próprio" revela uma resposta como Result: "ConfigError" com instruções de integração do tenant, distinta de uma falha de autenticação.

Recursos

Cada recurso tem sua própria página de referência. O verbo definido em cada página corresponde aos comandos registrados por uip ah — execute uip ah --help para confirmar a superfície completa em sua instalação.

Recurso	Finalidade
automações, fluxos de ideias, casos de negócios, fases, questionários, pipelines	O ciclo de vida principal da ideia à entrega: enviar e ler ideias de automação, descobrir transições de fase/status, ler análises de custo-benefício, mover ideias por fases, ler o catálogo de perguntas de avaliação e ler a visualização do pipeline classificado por benefício.
aplicativos, componentes, documentos, mídia, listagens de loja, avaliações de loja	As automações de inventário de aplicativos são marcadas em componentes reutilizáveis, documentos e mídia anexados e o marketplace da Automation Store ( listagens publicadas e suas avaliações).
categorias, tags, colaboradores, funções, usuários	A taxonomia da categoria, tags de texto livre, colaboradores por automação e suas funções, o catálogo de funções atribuíveis e contas de usuário do Automation Hub.
audit-logs, auth-info	Abordado abaixo nesta página — recursos utilitários pequenos e comuns.

logs de auditoria do uip ah

Leia a trilha de auditoria do Automation Hub. O Automation Hub agrupa a trilha em pacotes CSV semanais, em vez de em um log simples.

lista de logs de auditoria do uip ah

Lista pacotes de log de auditoria para um intervalo de datas.

Opções

Long	Valor	Description
--start-date <date>	YYYY-MM-DD	Início do intervalo.
--end-date <date>	YYYY-MM-DD	Fim do intervalo.
--limit <n>	Número inteiro	Número máximo de pacotes a serem retornados. 20Padrão.
--offset <n>	Número inteiro	Número de pacotes a pular. 0Padrão.
--all-fields	Bandeira	Retorne a carga bruta em vez dos campos Name/EntryCount projetados.

Ponto de extremidade não paginado — toda a coleção para o intervalo de datas é buscada e, em seguida, janelada do lado do cliente. Uma trilha vazia (um 404 "Nenhum log de auditoria foi encontrado") é dobrada em uma matriz Data vazia em vez de exibida como um erro.

Exemplo

uip ah audit-logs list --start-date 2026-07-01 --end-date 2026-08-04

Formato dos dados (--output json)

{
  "Code": "AhAuditLogsList",
  "Data": [
    { "Name": "tenant-service-audit-log-(2026-08-02)-to-(2026-08-08).csv", "EntryCount": 12 }
  ]
}

Um pacote apoiado por um blob de referência de objeto em vez de entradas embutidas retorna Uri (o valor download --uri assume) no lugar de EntryCount.

download dos logs de auditoria do uip ah

Salve um pacote de log de auditoria como um arquivo CSV local.

Opções

Long	Valor	Required	Description
--uri <name>	String	sim	Nome do pacote, exatamente como o campo Name de audit-logs list.
--destination <path>	Path	sim	Caminho local no qual gravar o CSV.

Exemplo

uip ah audit-logs download --uri <name> --destination ./audit.csv

Formato dos dados (--output json)

{ "Code": "AhAuditLogsDownload", "Data": { "Destination": "./audit.csv", "Bytes": 4096, "Rows": 20 } }

informações de autenticação do uiip ah

Recurso de nome em massa Singular — há exatamente uma identidade por sessão, portanto, não há nada para listar.

uip ah auth- web Info

Mostrar o tenant do Automation Hub e sua identidade nele — a verificação mais rápida de que o Automation Hub está habilitado e integrado para o tenant ativo.

Opções

Long	Description
--all-fields	Retorne a carga bruta em vez dos campos Type/Tenant/User resumidos.

Exemplo

uip ah auth-info get

Formato dos dados (--output json)

{
  "Code": "AhAuthInfoGet",
  "Data": {
    "Type": "automation-cloud",
    "Tenant": { "Uuid": "...", "CompanyName": "acme - finance", "Url": "..." },
    "User": {
      "Id": 3, "Email": "[e-mail]", "FirstName": "Jane", "LastName": "Doe",
      "JobTitle": "Analyst", "Department": "Finance", "BusinessUnit": "EMEA",
      "IsAdmin": 1, "IsActive": 1, "Roles": ["ah-system-admin"]
    }
  }
}

Resumo

uip ah audit-logs list [--start-date <date>] [--end-date <date>] [--limit <n>] [--offset <n>] [--all-fields]
uip ah audit-logs download --uri <name> --destination <path>
uip ah auth-info get [--all-fields]

Consulte automações, fluxos de ideias, casos de negócios, fases, questionários, pipelines, aplicativos, componentes, documentos, mídia, listagens de repositórios, repositórios e avaliações , tags, colaboradores, funções, usuários para o restante da superfície de comando .

Veja também

• Ferramentas ( plugins )
• Ferramentas da UIP
• Opções globais
• Códigos de saída