UiPath Documentation
uipath-cli
latest
false
Guía del usuario de UiPath CLI
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

UIP es conexiones

Sintaxis y opciones para `uip es conexiones`, que gestiona las sesiones OAuth entre un tenant de UiPath y conectores externos.

uip is connections gestiona las sesiones OAuth del tenant contra los conectores. Una conexión es el enlace autenticado entre una carpeta de tenant de UiPath y una cuenta externa; lleva los tokens que resources run y activities utilizan en runtime. Los verbos cubren el descubrimiento (list, export), la autenticación (create, edit), las comprobaciones de estado (ping) y la gestión (rename, set-default, update-polling-interval, base-url, delete). create y edit abren la URL OAuth del conector en un navegador y sondean el servidor para comprobar que se ha completado (intervalo de 5 segundos, tiempo de espera total de 5 minutos).

Sinopsis​

uip is connections <verb> [options]
uip is connections <verb> [options]

Verbos​

VerboPropósito
listEnumera las conexiones, opcionalmente en el ámbito de un conector, carpeta o estado BYOA.
exportExporta cada conexión (en todas las carpetas) para su auditoría.
createCrea una nueva conexión a través del flujo OAuth del conector.
pingComprueba si una conexión está habilitada actualmente y es accesible.
editVuelve a autenticar una conexión existente a través del flujo OAuth.
renameCambiar el nombre de una conexión existente.
set-defaultMarcar una conexión como predeterminada para su conector.
update-polling-intervalCambiar el intervalo de sondeo de una conexión.
base-urlObtener la URL base de la API en la que se resuelve una conexión.
deleteEliminar una conexión (destructivo, requiere -y/--yes).

uip es la lista de conexiones​

Enumerar las conexiones en el ámbito predeterminado del tenant. El <connector-key> posicional opcional filtra el resultado a un conector; los marcadores pueden abarcar por carpeta, ID de conexión o estado BYOA.

Argumentos​

NombreObligatorioPropósito
[connector-key]NoClave de conector por la que filtrar (por ejemplo, uipath-zoho-desk). Omitir en la lista en todos los conectores.

Opciones​

CortoLargoValorPredeterminadoDescripción
—--folder-keyUuid—Buscar conexiones en una carpeta específica. Debe ser un UUID. Mutuamente exclusivo con --all-folders.
—--connection-idid—Filtrar a un ID de conexión específico.
—--byoaMarcaDesactivadoFiltrar solo a conexiones BYOA (Bring Your Own Account).
—--all-foldersMarcaDesactivadoBuscar conexiones en todas las carpetas en lugar del ámbito predeterminado. Mutuamente excluyentes con --folder-key: combinarlos falla con un Failure antes de realizar cualquier solicitud.
—--refreshMarcaDesactivadoFuerza la nueva recuperación desde la API, ignorando la caché.

Ejemplos​

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}'
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}'

Forma de datos (--json de salida)​

{
  "Code": "ConnectionList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Zoho Desk - Prod",
      "ConnectorKey": "uipath-zoho-desk",
      "ConnectorName": "Zoho Desk",
      "State": "Enabled",
      "Owner": "user@example.com",
      "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"
    }
  ]
}
{
  "Code": "ConnectionList",
  "Data": [
    {
      "Id": "a1b2c3d4-0000-0000-0000-000000000001",
      "Name": "Zoho Desk - Prod",
      "ConnectorKey": "uipath-zoho-desk",
      "ConnectorName": "Zoho Desk",
      "State": "Enabled",
      "Owner": "user@example.com",
      "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"
    }
  ]
}

Si algunas conexiones están deshabilitadas, la respuesta incluye un campo Warning junto a Data. Un --folder-key no válido que no sea un UUID se rechaza por adelantado.

uip es exportación de conexiones​

Exporta cada conexión en todas las carpetas, con fines de auditoría. No toma argumentos ni opciones de ámbito de conexión: siempre cubre el tenant completo.

Argumentos​

Nada.

Ejemplo​

uip is connections export
uip is connections export

Forma de datos (--json de salida)​

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

Data es un mapa codificado por ID de conexión, no una matriz. Cuando el tenant no tiene ninguna conexión, la respuesta es {"Code": "Message", "Data": {"Message": "No connections found to export."}}.

UIP es crear conexiones​

Crea una nueva conexión a través del flujo OAuth del conector. La CLI abre la URL de autenticación en tu navegador (a menos que pases --no-browser) y sondea el servidor para que se complete. Intervalo de sondeo: 5 segundos. Tiempo de espera total: 5 minutos.

Argumentos​

NombreObligatorioPropósito
<connector-key>SíClave del conector, por ejemplo uipath-zoho-desk.

Opciones​

CortoLargoValorPredeterminadoDescripción
—--no-browserMarcaDesactivadoNo abra automáticamente el navegador; imprime la URL para la navegación manual.
—--no-waitMarcaDesactivadoDevuelve los detalles de autorización pendientes (SessionId, AuthUrl) inmediatamente en lugar de sondear para completar.

Ejemplos​

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
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

Forma de datos (--json de salida)​

{
  "Code": "ConnectionCreated",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000010",
    "ConnectionName": "Zoho Desk",
    "Connector": "Zoho Desk",
    "State": "Enabled",
    "Owner": "user@example.com",
    "Folder": "Shared",
    "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001"
  }
}
{
  "Code": "ConnectionCreated",
  "Data": {
    "ConnectionId": "a1b2c3d4-0000-0000-0000-000000000010",
    "ConnectionName": "Zoho Desk",
    "Connector": "Zoho Desk",
    "State": "Enabled",
    "Owner": "user@example.com",
    "Folder": "Shared",
    "FolderKey": "f0f0f0f0-0000-0000-0000-000000000001"
  }
}

Con --no-wait, la respuesta es en cambio la autorización pendiente:

{
  "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"
  }
}
{
  "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 fallo:

  • El usuario rechaza o la autenticación falla: Failure con el mensaje del servidor; salida 1.
  • Tiempo de espera de la encuesta (5 minutos): Failure: "Authentication timed out after 5 minutes"; salida 2.
  • Error de transporte de sondeo: Failure; salida 1.
  • Interrumpido/abortado (Ctrl+C): Failure; salida 1.

uip es ping de conexiones​

Comprueba si una conexión está habilitada actualmente y es accesible.

Argumentos​

NombreObligatorioPropósito
<connection-id>SíID de conexión (UUID) devuelto por connections list o connections create.

Opciones​

CortoLargoValorPredeterminadoDescripción
—--force-refreshMarcaDesactivadoFuerza una actualización del estado de la conexión en vivo en lugar de utilizar un estado en caché.

Ejemplos​

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

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

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

Forma de datos (--json de salida)​

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

Una conexión deshabilitada o inalcanzable emite Failure con Instructions: "Run 'uip is connections edit <id>' to re-authenticate.".

uip es edición de conexiones​

Vuelve a autenticar una conexión existente. El mismo flujo OAuth que create, dirigido a un ID de conexión existente en lugar de emitir uno nuevo. Mismo contrato de sondeo y códigos de salida.

Argumentos​

NombreObligatorioPropósito
<connection-id>SíID de conexión para volver a autenticar.

Opciones​

CortoLargoValorPredeterminadoDescripción
—--no-browserMarcaDesactivadoNo abra automáticamente el navegador; imprime la URL para la navegación manual.
—--no-waitMarcaDesactivadoDevuelve los detalles de la autorización pendiente inmediatamente en lugar de sondear para completar.

Ejemplos​

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

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

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

Forma de datos (--json de salida)​

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

Con --no-wait, la respuesta es la misma forma de autorización pendiente que se muestra en create anterior.

uip es cambiar el nombre de las conexiones​

Cambiar el nombre de una conexión existente.

Argumentos​

NombreObligatorioPropósito
<connection-id>SíID de conexión para cambiar el nombre.

Opciones​

CortoLargoValorPredeterminadoDescripción
—--nametext—Obligatorio. Nuevo nombre de conexión. No puede estar vacío.

Ejemplo​

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

Forma de datos (--json de salida)​

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

Un nuevo nombre en conflicto o no válido falla con Failure, apuntando a connections list para verificar el ID y elegir un nombre que no entre en conflicto.

uip es conexiones establecidas por defecto​

Marca una conexión como la conexión predeterminada para su conector: la elegida automáticamente cuando un conector solo permite un valor predeterminado activo.

Argumentos​

NombreObligatorioPropósito
<connection-id>SíID de conexión para establecer como predeterminado.

Ejemplo​

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

Forma de datos (--json de salida)​

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

uip es conexiones update-sondeo-intervalo​

Cambia la frecuencia con la que la conexión sondea eventos (utilizados por actividades/desencadenadores basados en eventos creados en esta conexión).

Argumentos​

NombreObligatorioPropósito
<connection-id>SíID de conexión para actualizar.

Opciones​

CortoLargoValorPredeterminadoDescripción
—--polling-intervalminutos—Obligatorio. Nuevo intervalo de sondeo, en minutos. Debe ser un número entero positivo.

Ejemplo​

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

Forma de datos (--json de salida)​

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

Un valor no entero o no positivo falla en el lado del cliente antes de enviar cualquier solicitud. Si la conexión no admite un intervalo de sondeo configurable, el servidor rechaza la solicitud: verifica el ID de conexión con connections list --refresh y confirma que el conector admite el sondeo.

UIP es la URL base de las conexiones​

Obtener la URL base de la API en la que se resuelve actualmente una conexión: útil al crear una solicitud HTTP sin procesar contra la API subyacente del conector.

Argumentos​

NombreObligatorioPropósito
<connection-id>SíID de conexión para inspeccionar.

Ejemplo​

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

Forma de datos (--json de salida)​

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

El error apunta a connections list para verificar el ID y confirmar que la conexión es Enabled.

uip es eliminar conexiones​

Eliminar una conexión. Esto es irreversible : la CLI nunca solicita.

Argumentos​

NombreObligatorioPropósito
<connection-id>SíID de conexión que se eliminará.

Opciones​

CortoLargoValorPredeterminadoDescripción
-y--yesMarca—Obligatorio. Confirma esta operación irreversible.

Ejemplo​

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

Forma de datos (--json de salida)​

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

Un ID de conexión desconocido falla con Failure apuntando a connections list --all-folders para encontrarlo.

Ver también​

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado