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

connexion uip

uip login authentifie la CLI par rapport à UiPath Cloud et conserve la session résultante dans un dossier .uipath/ local. Si cela réussit, la CLI dispose d’un jeton d’accès et d’un locataire sélectionné; les outils exécutés par des commandes ultérieures les récupèrent automatiquement. Voir Authentification pour le modèle d'informations d'identification et Sessions et informations d'identification pour l'emplacement du dossier.

Pour vérifier le statut, voir uip login status. Pour supprimer une session, voir uip logout.

Synthèse

uip login [--interactive] [--tenant <name>] [--organization <name>]
         [--authority <url>] [--client-id <id>] [--client-secret <secret>]
         [--scope <scopes>] [-f <folder>]
uip login tenant list [-f <folder>]
uip login tenant set <name> [-f <folder>]
uip login [--interactive] [--tenant <name>] [--organization <name>]
         [--authority <url>] [--client-id <id>] [--client-secret <secret>]
         [--scope <scopes>] [-f <folder>]
uip login tenant list [-f <folder>]
uip login tenant set <name> [-f <folder>]

Toutes les sous-commandes uip login respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard.

connexion uip

S’authentifie de manière interactive via le navigateur ou non interactive à l’aide des informations d’identification du client d’application externe.

Arguments

Aucun

Options

  • -f, --file <folder> - Chemin d'accès à un dossier d'informations d'identification. La session est conservée dans <folder>. Sans cela, la CLI utilise l’emplacement par défaut (voir Sessions et informations d’identification).
  • --authority <url> — URL d'autorité personnalisée. À utiliser pour les Clouds qui ne sont pas définis par défaut.
  • --client-id <id> — ID client ou ID d'application pour une application externe UiPath. Accepte env.NAME pour lire à partir d'une variable d'environnement.
  • --client-secret <secret> — Clé secrète du client pour une application externe confidentielle. Accepte env.NAME pour lire à partir d'une variable d'environnement.
  • -s, --scope <scopes> — Étendues séparées par des espaces (par exemple, "OR.Folders OR.Jobs"). À utiliser avec les informations d’identification de l’application externe.
  • -t, --tenant <name> — Nom du locataire (mode non interactif). Si omis, associez avec --interactive.
  • --organization <name> — Nom logique de l'organisation, présélectionné lors de la connexion du navigateur. Contourne le sélecteur d'organisation lorsque votre utilisateur se trouve dans plusieurs organisations.
  • --it, --interactive — Après l'authentification, invitez interactivement à sélectionner un locataire dans la liste renvoyée par le cloud.

Credential modes

  • Informations d’identification interactives/utilisateur — exécutez uip login (en option avec --interactive, --tenant ou --organization). Le flux du navigateur se termine sur l'autorité UiPath Cloud; les jetons qui en résultent sont conservés dans le dossier des informations d’identification.
  • Application externe (non interactif) : transmettez --client-id, --client-secret et --scope, généralement avec --tenant. Convient aux runtimes CI. Lisez le secret d’une variable d’environnement avec --client-secret env.UIPATH_CLIENT_SECRET pour le garder en dehors de votre historique du shell.

Exemples

# Browser-based interactive login, picks tenant at the end
uip login --interactive

# Log directly into a known org + tenant (no browser picker)
uip login --organization my-org --tenant DefaultTenant

# External Application with secret from environment variable
uip login \
  --client-id "00000000-0000-0000-0000-000000000001" \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --scope "OR.Folders OR.Jobs" \
  --tenant DefaultTenant

# Custom credentials folder (useful for scoping per-project sessions)
uip login --interactive -f ./.uipath
# Browser-based interactive login, picks tenant at the end
uip login --interactive

# Log directly into a known org + tenant (no browser picker)
uip login --organization my-org --tenant DefaultTenant

# External Application with secret from environment variable
uip login \
  --client-id "00000000-0000-0000-0000-000000000001" \
  --client-secret env.UIPATH_CLIENT_SECRET \
  --scope "OR.Folders OR.Jobs" \
  --tenant DefaultTenant

# Custom credentials folder (useful for scoping per-project sessions)
uip login --interactive -f ./.uipath

Data shape (--output json)

{
  "Code": "Authenticated",
  "Data": {
    "Status": "Logged in",
    "Organization": "my-org",
    "Tenant": "DefaultTenant"
  }
}
{
  "Code": "Authenticated",
  "Data": {
    "Status": "Logged in",
    "Organization": "my-org",
    "Tenant": "DefaultTenant"
  }
}

Modes d’échec

  • Le locataire manquant après une connexion non interactive génère une ConfigError avec Message: "No tenant selected" et vous indique de réexécuter avec --tenant <name> ou --interactive
  • Les erreurs de transport et les réponses non-2xx de l'autorité apparaissent sous la forme AuthenticationError, avec le statut HTTP d'origine dans Context.httpStatus lorsqu'il est disponible.
  • Une référence env.NAME mal formée dans --client-id / --client-secret produit une ConfigError avant tout appel réseau.

liste des locataires de connexion UiP

Répertorie tous les locataires visibles par l'utilisateur authentifié dans l'organisation actuelle. Nécessite une connexion active.

Arguments

Aucun

Options

  • -f, --file <folder> : le chemin d'accès au dossier des informations d'identification. La valeur par défaut est la session utilisée par le dernier uip login.

Exemple

uip login tenant list
uip login tenant list

Data shape (--output json)

{
  "Code": "TenantList",
  "Data": [
    {
      "TenantName": "DefaultTenant",
      "TenantId": "a1b2c3d4-0000-0000-0000-000000000001"
    },
    {
      "TenantName": "ProductionTenant",
      "TenantId": "a1b2c3d4-0000-0000-0000-000000000002"
    }
  ]
}
{
  "Code": "TenantList",
  "Data": [
    {
      "TenantName": "DefaultTenant",
      "TenantId": "a1b2c3d4-0000-0000-0000-000000000001"
    },
    {
      "TenantName": "ProductionTenant",
      "TenantId": "a1b2c3d4-0000-0000-0000-000000000002"
    }
  ]
}

Si la session n’est pas connectée, la commande génère AuthenticationError avec des instructions pour exécuter uip login au préalable.

ensemble de locataires de connexion UiP

Sélectionnez le locataire actif par nom. Le locataire doit exister dans la liste renvoyée par login tenant list; la CLI met à jour la session stockée avec la nouvelle sélection.

Arguments

  • <name> (requis) : le nom du locataire tel que renvoyé par uip login tenant list.

Options

  • -f, --file <folder> : le chemin d'accès au dossier des informations d'identification. La valeur par défaut est la session utilisée par le dernier uip login.

Exemple

uip login tenant set DefaultTenant
uip login tenant set DefaultTenant

Data shape (--output json)

{
  "Code": "TenantSet",
  "Data": {
    "Name": "DefaultTenant",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}
{
  "Code": "TenantSet",
  "Data": {
    "Name": "DefaultTenant",
    "Id": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

Modes d’échec

  • Nom de locataire inconnu produit ValidationError avec Instructions répertoriant les locataires disponibles, par exemple argument should be one of DefaultTenant, ProductionTenant.
  • Si la CLI ne peut pas mettre à jour la session stockée, l'erreur s'affiche sous la forme Failure avec une suggestion liée aux autorisations.

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