uip est des connexions

Syntaxe et options de `uip is connections`, qui gère les sessions OAuth entre un locataire UiPath et les connecteurs externes.

uip is connections gère les sessions OAuth du locataire par rapport aux connecteurs. Une connexion est le lien authentifié entre un dossier de locataire UiPath et un compte externe; il transporte les jetons que resources run et activities utilisent au moment du runtime. Les verbes couvrent la découverte (list, export), l'authentification (create, edit), les vérifications de l'état (ping) et la gestion (rename, set-default, update-polling-interval, base-url) }, delete). create et edit ouvrent l’URL OAuth du connecteur dans un navigateur et interrogent le serveur pour vérifier l'achèvement (intervalle de 5 secondes, délai d’expiration total de 5 minutes).

Synthèse

uip is connections <verb> [options]

Verbes

Verbe	Objectif
list	Répertorier les connexions, éventuellement limitées à un connecteur, un dossier ou un statut BYOA.
export	Exportez chaque connexion (dans tous les dossiers) pour l'audit.
create	Créez une nouvelle connexion via le flux OAuth du connecteur.
ping	Vérifiez si une connexion est actuellement activée et accessible.
edit	Ré-authentifiez une connexion existante via le flux OAuth.
rename	Renommez une connexion existante.
set-default	Marquez une connexion comme connexion par défaut pour son connecteur.
update-polling-interval	Modifier l'intervalle d'interrogation d'une connexion.
base-url	Obtenez l'URL de base de l'API vers laquelle une connexion se résout.
delete	Supprimer une connexion (irréversible, nécessite -y/--yes).

uip est une liste de connexions

Répertoriez les connexions dans l’étendue par défaut du locataire. Le filtre <connector-key> positionnel facultatif filtre le résultat sur un connecteur; Ces indicateurs peuvent s'étendre par dossier, ID de connexion ou statut BYOA.

Arguments

Nom	Requis	Objectif
[connector-key]	non	Clé de connecteur par laquelle filtrer (par exemple, uipath-zoho-desk). Omettre afin de répertorier tous les connecteurs.

Options

Short	Long	Valeur (Value)	Default	Description
—	--folder-key	UUID	—	Recherchez des connexions dans un dossier spécifique. Doit être un UUID. Capture mutuellement exclusive avec --all-folders.
—	--connection-id	id	—	Filtrez sur un ID de connexion spécifique.
—	--byoa	Drapeau	désactivé	Filtrez sur les connexions BYOA uniquement.
—	--all-folders	Drapeau	désactivé	Recherchez des connexions dans tous les dossiers au lieu de l'étendue par défaut. mutuellement exclusif avec --folder-key - leur combinaison échoue avec un Failure avant qu'une demande ne soit effectuée.
—	--refresh	Drapeau	désactivé	Forcer la réextraction à partir de l’API, en ignorant le cache.

Exemples

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

Format des données (--sortie 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"
    }
  ]
}

Si certaines connexions sont désactivées, la réponse comporte un champ Warning avec Data. Un élément --folder-key non valide qui n’est pas un UUID est rejeté dès le départ.

uip est l'exportation des connexions

Exportez chaque connexion dans tous les dossiers, à des fins d’audit. Ne prend aucun argument ni aucune option d’étendue de connexion; il couvre toujours l’ensemble du locataire.

Arguments

Aucun

Exemple

uip is connections export

Format des données (--sortie json)

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

Data est une carte clés par ID de connexion — pas un tableau. Lorsque le locataire n’a aucune connexion, la réponse est {"Code": "Message", "Data": {"Message": "No connections found to export."}}.

uip est création de connexions

Créez une nouvelle connexion via le flux OAuth du connecteur. La CLI ouvre l'URL d'authentification dans votre navigateur (sauf si vous réussissez --no-browser) et interroge le serveur pour vérifier l'achèvement. Intervalle d'interrogation: 5 secondes. Délai d’expiration total: 5 minutes.

Arguments

Nom	Requis	Objectif
<connector-key>	oui	Clé du connecteur, par exemple uipath-zoho-desk.

Options

Short	Long	Valeur (Value)	Default	Description
—	--no-browser	Drapeau	désactivé	N’ouvrez pas automatiquement le navigateur; imprimez l'URL pour la navigation manuelle.
—	--no-wait	Drapeau	désactivé	Renvoyez immédiatement les détails d’autorisation en attente (SessionId, AuthUrl) au lieu d’une interrogation pour déterminer l'achèvement.

Exemples

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

Format des données (--sortie 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"
  }
}

Avec --no-wait, la réponse correspond à l’autorisation en attente:

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

Modes d’échec:

• L’utilisateur refuse ou échoue l’authentification: Failure avec le message du serveur; quitter 1.
• Délai d’interrogation (5 minutes): Failure: "Authentication timed out after 5 minutes"; quitter 2.
• Échec du transport de l’interrogation: Failure; quitter 1.
• Interrompu/abandonné: Failure; quitter 1.

uip est ping de connexions

Vérifiez si une connexion est actuellement activée et accessible.

Arguments

Nom	Requis	Objectif
<connection-id>	oui	ID de connexion (UUID) renvoyé par connections list ou connections create.

Options

Short	Long	Valeur (Value)	Default	Description
—	--force-refresh	Drapeau	désactivé	Forcez une actualisation du statut de la connexion en direct au lieu d’utiliser un statut mis en cache.

Exemples

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

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

Format des données (--sortie json)

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

Une connexion désactivée ou inaccessible génère Failure avec Instructions: "Run 'uip is connections edit <id>' to re-authenticate.".

uip est modification des connexions

Ré-authentifiez une connexion existante. Même flux OAuth que create, ciblant un ID de connexion existant plutôt que d’en émettre un nouveau. Contrat d’interrogation et codes de sortie identiques.

Arguments

Nom	Requis	Objectif
<connection-id>	oui	ID de connexion pour authentifier à nouveau.

Options

Short	Long	Valeur (Value)	Default	Description
—	--no-browser	Drapeau	désactivé	N’ouvrez pas automatiquement le navigateur; imprimez l'URL pour la navigation manuelle.
—	--no-wait	Drapeau	désactivé	Renvoyez immédiatement les détails d’autorisation en attente au lieu d’une interrogation pour complétion.

Exemples

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

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

Format des données (--sortie json)

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

Avec --no-wait, la réponse est la même forme d'autorisation en attente affichée sous create ci-dessus.

uip est un changement de nom de connexions

Renommez une connexion existante.

Arguments

Nom	Requis	Objectif
<connection-id>	oui	ID de connexion à renommer.

Options

Short	Long	Valeur (Value)	Default	Description
—	--name	text	—	Requis. Nouveau nom de connexion. Ne peut pas être vide.

Exemple

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

Format des données (--sortie json)

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

Un nouveau nom en conflit ou non valide échoue avec Failure, pointant sur connections list pour vérifier l’ID et choisir un nom non conflictuel.

uip est défini par défaut des connexions

Marquez une connexion comme connexion par défaut pour son connecteur - celle sélectionnée automatiquement lorsqu'un connecteur autorise uniquement une connexion par défaut active.

Arguments

Nom	Requis	Objectif
<connection-id>	oui	ID de connexion à définir par défaut.

Exemple

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

Format des données (--sortie json)

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

uip est des connexions mise à jour-interrogation-intervalle

Modifiez la fréquence des interrogations de connexion pour les événements (utilisées par les activités/les déclencheurs axés sur les événements construits sur cette connexion).

Arguments

Nom	Requis	Objectif
<connection-id>	oui	ID de connexion à mettre à jour.

Options

Short	Long	Valeur (Value)	Default	Description
—	--polling-interval	minutes	—	Requis. Nouvel intervalle d’interrogation, en minutes. Doit être un entier positif.

Exemple

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

Format des données (--sortie json)

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

Une valeur non entière ou non positive échoue côté client avant l'envoi d'une requête. Si la connexion ne prend pas en charge un intervalle d'interrogation configurable, le serveur rejette la requête: vérifiez l'ID de connexion avec connections list --refresh et confirmez que le connecteur prend en charge l'interrogation.

uip est des connexions - URL de base

Obtenez l'URL de base de l'API vers laquelle une connexion est actuellement résolue - utile lors de la création d'une requête HTTP brute par rapport à l'API sous-jacente du connecteur.

Arguments

Nom	Requis	Objectif
<connection-id>	oui	ID de connexion à inspecter.

Exemple

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

Format des données (--sortie json)

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

Échec au niveau de connections list pour vérifier l’ID et confirmer que la connexion est Enabled.

uip est la suppression des connexions

Supprimer une connexion. Ceci est irréversible - la CLI ne s'affiche jamais.

Arguments

Nom	Requis	Objectif
<connection-id>	oui	ID de connexion à supprimer.

Options

Short	Long	Valeur (Value)	Default	Description
-y	--yes	Drapeau	—	Requis. Confirme cette opération irréversible.

Exemple

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

Format des données (--sortie json)

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

Un ID de connexion inconnu échoue avec Failure pointant sur connections list --all-folders pour le trouver.

Associé

• uip is connectors — découvrir les clés du connecteur pour create.
• uip is resources — resources run requiert --connection-id d'une connexion ici.
• uip is activities — répertorier les opérations que la connexion peut piloter.
• uip is triggers — hooks d'événements activés via une connexion.

Voir également

• Présentation de l’outil Integration Service
• Options globales
• Codes de sortie