UiPath Documentation
uipath-cli
latest
false
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

Guide de l'utilisateur de UiPath CLI

uip est des connexions

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 execute et activities utilisent au moment du runtime. Les verbes couvrent la découverte (list), l'authentification (create, edit) et les vérifications de l'état (ping). create et edit ouvrent l'URL OAuth du connecteur dans un navigateur et interrogent le serveur pour qu'elle soit terminée (intervalle de 5 secondes, délai d'expiration total de 5 minutes).

Synthèse

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

Verbes

VerbeObjectif
listRépertorier les connexions, éventuellement limitées à un connecteur ou à un dossier.
createCréez une nouvelle connexion via le flux OAuth du connecteur.
pingVérifiez si une connexion est actuellement activée et accessible.
editRé-authentifiez une connexion existante via le flux OAuth.

uip est une liste de connexions

Répertorier les connexions dans le locataire. Le filtre <connector-key> positionnel facultatif filtre le résultat sur un connecteur; les indicateurs peuvent s'étendre par dossier ou par ID de connexion unique.

Arguments

NomRequisObjectif
[connector-key]nonClé de connecteur par laquelle filtrer (par exemple, uipath-zoho-desk). Omettre afin de répertorier tous les connecteurs.

Options

ShortLongValeur (Value)DefaultDescription
--folder-keyUUIDClé de dossier par laquelle filtrer. Doit être un UUID.
--connection-ididFiltrez sur un ID de connexion spécifique.
-t--tenantnamesession par défautRemplacer le locataire.
--refreshDrapeaudé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 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 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": "user@example.com",
      "IsDefault": "No",
      "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",
      "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 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

NomRequisObjectif
<connector-key>ouiClé du connecteur, par exemple uipath-zoho-desk.

Options

ShortLongValeur (Value)DefaultDescription
-t--tenantnamesession par défautRemplacer le locataire.
--no-browserDrapeaudésactivéN’ouvrez pas automatiquement le navigateur; imprimez l'URL pour la navigation manuelle.

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

Format des données (--sortie json)

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

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

NomRequisObjectif
<connection-id>ouiID de connexion (UUID) renvoyé par connections list ou connections create.

Options

ShortLongValeur (Value)DefaultDescription
-t--tenantnamesession par défautRemplacer le locataire.

Exemples

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

Format des données (--sortie json)

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

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

NomRequisObjectif
<connection-id>ouiID de connexion pour authentifier à nouveau.

Options

ShortLongValeur (Value)DefaultDescription
-t--tenantnamesession par défautRemplacer le locataire.
--no-browserDrapeaudésactivéN’ouvrez pas automatiquement le navigateur; imprimez l'URL pour la navigation manuelle.

Exemples

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

Format des données (--sortie json)

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

Voir également

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour