uip é conexões

Sintaxe e opções para "uip is Connections", que gerencia sessões do OAuth entre um tenant da UiPath e conectores externos.

uip is connections gerencia as sessões do OAuth do tenant em relação a conectores. Uma conexão é o link autenticado entre uma pasta do tenant da UiPath e uma conta externa; ele carrega os tokens que resources run e activities usam no runtime. Os verbos cobrem descoberta (list, export), autenticação (create, edit), verificações de integridade (ping) e gerenciamento (rename, set-default, update-polling-interval, base-url, delete). create e edit abrem o URL OAuth do conector em um navegador e pesquisam o servidor para obter a conclusão (intervalo de 5 segundos, tempo limite total de 5 minutos).

Resumo

uip is connections <verb> [options]

Verbo

Texto	Finalidade
list	Listar conexões, opcionalmente com escopo de um conector, pasta ou status BYOA.
export	Exporte cada conexão (em todas as pastas) para auditoria.
create	Crie uma nova conexão por meio do fluxo OAuth do conector.
ping	Verifique se uma conexão está habilitada e acessível no momento.
edit	Autentique novamente uma conexão existente por meio do fluxo do OAuth.
rename	Renomeie uma conexão existente.
set-default	Marcar uma conexão como padrão para seu conector.
update-polling-interval	Altera o intervalo de pesquisa de uma conexão.
base-url	Obtenha o URL base da API para o qual uma conexão é resolvida.
delete	Exclua uma conexão (destrutiva, requer -y/--yes).

uip é lista de conexões

Liste conexões no escopo padrão do tenant. Posicional <connector-key> opcional filtra o resultado para um conector; Os sinalizadores podem delimitar por pasta, ID de conexão ou status de BYOA.

Argumentos

Name	Required	Finalidade
[connector-key]	não	Chave de conector pela qual filtrar (por exemplo, uipath-zoho-desk). Omita para listar todos os conectores.

Opções

Short	Long	Valor	Padrão	Description
—	--folder-key	UUID	—	Pesquise conexões em uma pasta específica. Deve ser um UUID. mutuamente exclusivo com --all-folders.
—	--connection-id	id	—	Filtre para um ID de conexão específico.
—	--byoa	Bandeira	desativada	Filtrar apenas para conexões BYOA (Traga sua própria conta).
—	--all-folders	Bandeira	desativada	Pesquisa conexões em todas as pastas em vez do escopo padrão. mutuamente exclusivo com --folder-key — combiná-los falha com um Failure antes que qualquer solicitação seja feita.
—	--refresh	Bandeira	desativada	Força a nova busca da API, ignorando o cache.

Exemplos

uip is connections list

uip is connections list uipath-zoho-desk

uip is connections list --byoa --all-folders

uip is connections list uipath-zoho-desk --refresh \
    --output-filter 'Data[].{id:Id, state:State}'

Formato dos dados (--output json)

{
  "Code": "ConnectionList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Zoho Desk - Prod",
      "ConnectorKey": "uipath-zoho-desk",
      "ConnectorName": "Zoho Desk",
      "State": "Enabled",
      "Owner": "[e-mail]",
      "IsDefault": "No",
      "ByoaConnection": "No",
      "ElementInstanceId": 123456,
      "Folder": "Shared",
      "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001",
      "Created": "2026-01-10T10:00:00.000Z",
      "Updated": "2026-01-10T10:00:00.000Z"
    }
  ]
}

Se algumas conexões estiverem desabilitadas, a resposta carregará um campo Warning ao lado de Data. Um --folder-key inválido que não é um UUID é rejeitado antecipadamente.

uip é exportação de conexões

Exporte cada conexão em todas as pastas, para fins de auditoria. Não aceita argumentos ou opções de escopo de conexão — sempre abrange o tenant completo.

Argumentos

Nenhum.

Exemplo

uip is connections export

Formato dos dados (--output json)

{
  "Code": "ConnectionExport",
  "Data": {
    "a1b2c3d4-0000-0000-0000-000000000001": {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "Zoho Desk - Prod",
      "state": "Enabled"
    }
  }
}

Data é um mapa chaveado pelo ID de conexão — não uma matriz. Quando o tenant não tem conexões, a resposta é {"Code": "Message", "Data": {"Message": "No connections found to export."}}.

uip são conexões criadas

Crie uma nova conexão por meio do fluxo OAuth do conector. A CLI abre o URL de autenticação no seu navegador (a menos que você passe --no-browser) e pesquisa o servidor para conclusão. Intervalo de pesquisa: 5 segundos. Tempo limite total: 5 minutos.

Argumentos

Name	Required	Finalidade
<connector-key>	sim	Chave de conector, por exemplo uipath-zoho-desk

Opções

Short	Long	Valor	Padrão	Description
—	--no-browser	Bandeira	desativada	Não abra o navegador automaticamente; imprimir o URL para navegação manual.
—	--no-wait	Bandeira	desativada	Retorne os detalhes de autorização pendentes (SessionId, AuthUrl) imediatamente em vez de pesquisar a conclusão.

Exemplos

uip is connections create uipath-zoho-desk

# Headless / CI-friendly — print the URL instead of launching a browser
uip is connections create uipath-zoho-desk --no-browser

# Return immediately with the pending session instead of polling
uip is connections create uipath-zoho-desk --no-browser --no-wait

Formato dos dados (--output json)

{
  "Code": "ConnectionCreated",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000010",
    "ConnectionName": "Zoho Desk",
    "Connector": "Zoho Desk",
    "State": "Enabled",
    "Owner": "[e-mail]",
    "Folder": "Shared",
    "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001"
  }
}

Com --no-wait, a resposta é a autorização pendente:

{
  "Code": "ConnectionAuthorizationPending",
  "Data": {
    "Status": "AuthorizationPending",
    "SessionId": "s1000000-0000-0000-0000-000000000001",
    "AuthUrl": "https://.../authorize?...",
    "Instructions": "Open AuthUrl to authorize the connection, then run 'uip is connections list' or 'uip is connections ping <connection-id>' to verify the connection.",
    "Connector": "uipath-zoho-desk"
  }
}

Modos de falha:

• O usuário recusa ou a autenticação falha: Failure com a mensagem do servidor; saída 1.
• Tempo limite de enquete (5 minutos): Failure: "Authentication timed out after 5 minutes"; saída 2.
• Falha no transporte de pesquisa: Failure; saída 1.
• Interrompido/anulado (Ctrl+C): Failure; saída 1.

uip é conexões ping

Verifique se uma conexão está habilitada e acessível no momento.

Argumentos

Name	Required	Finalidade
<connection-id>	sim	ID de conexão (UUID) retornado por connections list ou connections create.

Opções

Short	Long	Valor	Padrão	Description
—	--force-refresh	Bandeira	desativada	Força uma atualização de status de conexão em tempo real em vez de usar um status em cache.

Exemplos

uip is connections ping a1b2c3d4-0000-0000-0000-000000000001

uip is connections ping a1b2c3d4-0000-0000-0000-000000000001 --force-refresh

Formato dos dados (--output json)

{
  "Code": "ConnectionPing",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Status": "Enabled",
    "Message": "Connection is active."
  }
}

Uma conexão desabilitada ou inacessível emite Failure com Instructions: "Run 'uip is connections edit <id>' to re-authenticate.".

uip é edição de conexões

Autentique novamente uma conexão existente. Mesmo fluxo de OAuth que create, direcionado a um ID de conexão existente em vez de emitir um novo. Mesmo contrato de pesquisa e códigos de saída.

Argumentos

Name	Required	Finalidade
<connection-id>	sim	ID de conexão para autenticar novamente.

Opções

Short	Long	Valor	Padrão	Description
—	--no-browser	Bandeira	desativada	Não abra o navegador automaticamente; imprimir o URL para navegação manual.
—	--no-wait	Bandeira	desativada	Retorne os detalhes de autorização pendente imediatamente em vez de pesquisar a conclusão.

Exemplos

uip is connections edit a1b2c3d4-0000-0000-0000-000000000001

uip is connections edit a1b2c3d4-0000-0000-0000-000000000001 --no-browser

Formato dos dados (--output json)

{
  "Code": "ConnectionEdited",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "State": "Enabled"
  }
}

Com --no-wait, a resposta é o mesmo formato de autorização pendente mostrado em create acima.

uip é renomeação de conexões

Renomeie uma conexão existente.

Argumentos

Name	Required	Finalidade
<connection-id>	sim	ID de conexão a ser renomeado.

Opções

Short	Long	Valor	Padrão	Description
—	--name	text	—	Obrigatório. Novo nome da conexão. Não pode estar vazio.

Exemplo

uip is connections rename a1b2c3d4-0000-0000-0000-000000000001 \
    --name "Zoho Desk - Production"

Formato dos dados (--output json)

{
  "Code": "ConnectionRenamed",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Zoho Desk - Production"
  }
}

Um novo nome conflitante ou inválido falha com Failure, apontando para connections list para verificar o ID e escolher um nome não conflitante.

uip é conexões definir-padrão

Marque uma conexão como a conexão padrão para seu conector — aquela escolhida automaticamente onde um conector permite apenas um padrão ativo.

Argumentos

Name	Required	Finalidade
<connection-id>	sim	ID da conexão a ser definido como padrão.

Exemplo

uip is connections set-default a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)

{
  "Code": "ConnectionSetDefault",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Message": "Connection set as default."
  }
}

uip é conexões update-polling-interval

Altera com que frequência a conexão pesquisa eventos (usados por atividades/gatilhos orientados por eventos criados nessa conexão).

Argumentos

Name	Required	Finalidade
<connection-id>	sim	ID de conexão a ser atualizado.

Opções

Short	Long	Valor	Padrão	Description
—	--polling-interval	minutos	—	Obrigatório. Novo intervalo de pesquisa, em minutos. Deve ser um número inteiro positivo.

Exemplo

uip is connections update-polling-interval a1b2c3d4-0000-0000-0000-000000000001 \
    --polling-interval 15

Formato dos dados (--output json)

{
  "Code": "ConnectionPollingIntervalUpdated",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "PollingIntervalInMinutes": 15
  }
}

Um valor não inteiro ou não positivo falha no lado do cliente antes que qualquer solicitação seja enviada. Se a conexão não for compatível com um intervalo de pesquisa configurável, o servidor rejeitará a solicitação — verifique o ID da conexão com connections list --refresh e confirme que o conector é compatível com pesquisa.

uip é conexões url base

Obter o URL base da API para o qual uma conexão é resolvida atualmente — útil ao criar uma solicitação HTTP bruta contra a API subjacente do conector.

Argumentos

Name	Required	Finalidade
<connection-id>	sim	ID de conexão para inspecionar.

Exemplo

uip is connections base-url a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)

{
  "Code": "ConnectionBaseUrl",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "BaseUrl": "https://api.example.com/v2"
  }
}

A falha aponta para connections list para verificar o ID e confirmar que a conexão é Enabled.

uip é conexões excluir

Exclua uma conexão. Isso é irreversível — a CLI nunca solicita.

Argumentos

Name	Required	Finalidade
<connection-id>	sim	ID de conexão a ser excluído.

Opções

Short	Long	Valor	Padrão	Description
-y	--yes	Bandeira	—	Obrigatório. Confirma esta operação irreversível.

Exemplo

uip is connections delete a1b2c3d4-0000-0000-0000-000000000001 --yes

Formato dos dados (--output json)

{
  "Code": "ConnectionDeleted",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Message": "Connection deleted successfully."
  }
}

Um ID de conexão desconhecido falha com Failure apontando para connections list --all-folders para encontrá-lo.

Relacionado

• uip is connectors — descubra as chaves do conector para create.
• uip is resources — resources run requer --connection-id de uma conexão aqui.
• uip is activities — liste as operações que a conexão pode gerar.
• uip is triggers — ganchos de evento ativados por meio de uma conexão.

Veja também

• Visão geral da ferramenta do Integration Service
• Opções globais
• Códigos de saída