- Vue d'ensemble (Overview)
- Démarrer
- Concepts
- Utilisation de la UiPath CLI
- UiPath pour les agents de codage
- Guides pratiques
- Revenus CI/CD
- Référence de commande
- Vue d'ensemble (Overview)
- Codes de sortie
- Options globales
- agent codé uip
- UiPath Docsai
- add-test-data-entity
- ajouter une file d'attente de données de test
- add-test-data-variation
- Analyser
- Construire
- créer-projet
- Différence
- recherche-activités
- Obtenir les règles de l'analyse
- récupérer-activité-xaml par défaut
- Récupérer les erreurs
- obtenir des cas de test manuels
- Obtenir les étapes de test manuelles
- Obtenir les versions
- exemple de workflow
- indiquer l'application
- indiquer l'élément
- inspecter-package
- install-data-fabric-entities
- installer-ou-Update-packages
- list-data-fabric-entités
- listes-exemples-workflow
- Créer un package
- restore
- Exécuter le fichier
- modèles-recherche
- Démarrer-Studio
- arrêter l'exécution
- UIA
- Traçages UIP
- Migration
- Référence et assistance
Guide de l'utilisateur de UiPath CLI
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
| Verbe | Objectif |
|---|---|
list | Répertorier les connexions, éventuellement limitées à un connecteur ou à un dossier. |
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. |
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
| 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 | — | Clé de dossier par laquelle filtrer. Doit être un UUID. |
| — | --connection-id | id | — | Filtrez sur un ID de connexion spécifique. |
-t | --tenant | name | session par défaut | Remplacer le locataire. |
| — | --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 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
| Nom | Requis | Objectif |
|---|---|---|
<connector-key> | oui | Clé du connecteur, par exemple uipath-zoho-desk. |
Options
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
-t | --tenant | name | session par défaut | Remplacer le locataire. |
| — | --no-browser | Drapeau | dé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:
Failureavec le message du serveur; quitter1. - Délai d’interrogation (5 minutes):
Failure: "Authentication timed out after 5 minutes"; quitter2. - Échec du transport de l’interrogation:
Failure; quitter1. - Interrompu/abandonné:
Failure; quitter1.
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 |
|---|---|---|---|---|
-t | --tenant | name | session par défaut | Remplacer 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
| Nom | Requis | Objectif |
|---|---|---|
<connection-id> | oui | ID de connexion pour authentifier à nouveau. |
Options
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
-t | --tenant | name | session par défaut | Remplacer le locataire. |
| — | --no-browser | Drapeau | dé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"
}
}
Associé
uip is connectors— découvrir les clés du connecteur pourcreate.uip is resources—executeverbes nécessitent--connection-idd'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
- Synthèse
- Verbes
- uip est une liste de connexions
- Arguments
- Options
- Exemples
- Format des données (--sortie json)
- uip est création de connexions
- Arguments
- Options
- Exemples
- Format des données (--sortie json)
- uip est ping de connexions
- Arguments
- Options
- Exemples
- Format des données (--sortie json)
- uip est modification des connexions
- Arguments
- Options
- Exemples
- Format des données (--sortie json)
- Associé
- Voir également