Sessions et informations d’identification

Une session uip est l'état qui lie une commande à une organisation et à un locataire UiPath spécifiques, et qui permet à la CLI de présenter un jeton d'accès valide sans inviter l'utilisateur à chaque appel. Les sessions sont conservées sur le disque pour les flux interactifs et d'application externe, et sont reconstruites à partir des variables d'environnement pour le flux env-var. Cette page explique où cet état se trouve, comment uip le trouve et à quoi s'attendre lorsque vous déplacez entre des locataires ou des machines.

Le dossier des informations d’identification

uip login conserve la session dans un dossier appelé .uipath/. Traitez son contenu comme flou: il est géré par uip login, uip login tenant set et uip logout, et la mise en page sur disque est un détail d'implémentation qui peut changer d'une version à l'autre. Le dossier contient un jeton d'accès, un jeton de réactualisation, ainsi que l'organisation et le locataire actifs.

Protégez le dossier. Il contient des jetons qui peuvent emprunter l’identité de votre session jusqu’à ce qu’ils soient révoqués. Dans les environnements multi-utilisateurs ou partagés, conservez-les dans un répertoire de base avec les autorisations 0600 habituelles sur son contenu. Sur une machine de développement, il suffit généralement de la laisser à l'emplacement où uip login la place. Ajoutez .uipath/ à .gitignore si une session locale de projet est effectuée par développeur.

Résolution de l'emplacement

Lorsqu'une commande uip s'exécute, la CLI recherche le dossier d'informations d'identification dans cet ordre:

1. Chemin explicite : si une commande a été invoquée avec -f /path/to/folder, ce dossier est utilisé. Le chemin peut être absolu ou relatif.
2. Remonter depuis le répertoire actuel - à partir de cwd, la CLI vérifie ./.uipath/, puis parcourt la chaîne parente à la recherche du même dossier. La première qu'elle trouve l'emporte.
3. Accueil de l'utilisateur — si aucun dossier local du projet n'a été trouvé dans la fenêtre contextuelle, la CLI revient à ~/.uipath/.

uip login écrit dans le chemin qui sera lu par la commande suivante:

• Si vous avez exécuté uip login à l’intérieur d’un répertoire avec un .uipath/ existant sur la chaîne de runtime, la connexion actualise cette session en place.
• Sinon, il crée ~/.uipath/ dans votre répertoire de base.

Pourquoi participer?

La remontée à partir de cwd permet à un dossier de projet d’effectuer sa propre session sans modifier votre répertoire de base. Placez un dossier .uipath/ dans une racine de référentiel, et tous ceux qui exécutent uip depuis l'intérieur du référentiel récupèrent la connexion de ce projet - utile pour les informations d'identification du client par projet, les locataires d'organisation ou les environnements de démonstration.

Remplacer l'emplacement

Trois façons de remplacer la recherche:

• -f, --file <folder> sur uip login et uip logout — utilisez le dossier spécifié pour cette commande uniquement.
• Un répertoire de base distinct — sur un serveur de développement partagé, exécutez HOME=/srv/build-home uip login pour écrire dans /srv/build-home/.uipath/
• uip completion et d'autres commandes ne prennent pas un indicateur -f et utilisent toujours la pile de secours + accueil.

Pour l’inspection:

# print the current session status (reads via walk-up)
uip login status

uip login status lit toujours via le run-up + le repli d’accueil; il n'accepte pas -f. Pour inspecter une session dans un dossier non par défaut, accédez à ce répertoire (ou à un sous-répertoire de celui-ci) avant d'exécuter uip login status, ou répertoriez les locataires disponibles avec uip login tenant list -f /path/to/creds.

Organisation et locataire actifs

Une session stocke une seule organisation et un locataire à la fois. Le locataire est le concept UiPath qui étend les dossiers, les tâches, les files d'attente et les ressources - efficacement le « compte» que la CLI atteint chaque fois que vous exécutez uip or ….

Modifiez le locataire actif sans réauthentifier:

uip login tenant list           # show all tenants this session can access
uip login tenant set MyTenant   # switch the active tenant

En arrière-plan, uip login tenant set extrait les nouveaux jetons d'accès/d'actualisation pour le nouveau locataire et met à jour la session stockée en place.

Transmettez --tenant <name> sur n'importe quel appel uip or … pour remplacer le locataire actif de la session pour une seule commande, sans modifier la session sur disque:

uip or folders list --tenant Staging
uip or jobs start "$PROCESS_KEY" --tenant Production

Actualisation des jetons

Les jetons d’accès sont éphémères. Lorsque la CLI détecte que le jeton d'accès stocké approche de son expiration, il utilise le jeton de réactualisation pour en demander un nouveau et met à jour silencieusement la session stockée. Vous n'avez pas besoin de réexécuter uip login sauf si l'un des événements suivants se produit:

• Le jeton d’actualisation expire ou est révoqué (généralement après des semaines d’inactivité, ou lorsqu’un administrateur force une déconnexion).
• Vous avez modifié l’organisation.
• Vous avez besoin d’un ensemble d’étendues différent de celui avec lequel la session a été authentifiée.

uip login status signale Expired lorsque l’actualisation a échoué; qui est le signal pour exécuter à nouveau uip login .

Le flux env-var (aucun fichier)

Le troisième flux d'authentification, activé par UIPATH_CLI_ENABLE_ENV_AUTH=true, contourne entièrement le dossier d'informations d'identification. Chaque commande uip lit le jeton et le locataire à partir des variables d'environnement, les utilise telles quelles et n'écrit rien sur le disque.

C’est le bon choix pour:

• Conteneurs qui reçoivent un jeton d'un pipeline parent.
• Exécutions de CI éphémères où la persistance des informations d’identification sur le disque est gaspillage ou interdite.
• Tout environnement dans lequel la CLI doit être sans état entre les invocations.

Différences avec les flux basés sur des fichiers:

• Aucune actualisation. Le jeton est dense au paramètre uip — s'il a expiré, l'appelant est responsable de sa rotation.
• uip logout ne fait rien. Il n’y a aucun fichier à supprimer. Désactivez les variables d’environnement sur « se déconnecter ».
• L'URL de base est dérivée du jeton. Quelle que soit la revendication iss apportée par JWT, elle est traitée comme faisant foi - ne définissez pas UIPATH_URL en tant que UIPATH_CLI_AUTH_TOKEN, ou vous le désynchroniserez.

Voir Authentification — Flux 3 pour l'ensemble complet de variables et d'exemples d'actions/de conteneurs GitHub.

Déconnexion

Flux basés sur des fichiers:

uip logout                        # clear ~/.uipath/ or the walk-up match
uip logout -f /path/to/creds      # clear a specific credentials folder

logout efface la session stockée. Les appels uip or … suivants échoueront avec AuthenticationError (code de sortie 2) jusqu’à ce que vous exécutiez uip login à nouveau. Pour invalider également la session côté serveur, révoquez le secret de l’application externe dans Automation Cloud ou déconnectez-vous de votre compte utilisateur.

Flux Env-var: non défini UIPATH_CLI_ENABLE_ENV_AUTH (et les variables de jeton, pour plus de sécurité).

Voir également

• Authentification — les trois flux qui écrivent ou contournent le dossier d'informations d'identification.
• Configuration — priorité variable d'environnement, qui se trouve à côté du dossier des informations d'identification, mais distincte de celui-ci.
• référence de connexion uip, référence du statut de connexion uip, référence de déconnexion uip — listes et exemples d'indicateurs par commande.
• Installation de UiPath CLI — Supprimer les informations d'identification et les données — nettoyage après la désinstallation.