- 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 agent list et uip agent share fonctionnent tous deux sur des solutions Studio Web, la représentation côté cloud d'un projet d'agent. list énumère des solutions visibles par l’utilisateur actuel; share gère l'accès des utilisateurs et des groupes à une même solution. Ils sont regroupés ici car les deux sont de purs verbes de gestion de Studio Web, distincts des opérations au niveau du fichier dans uip agent file et des opérations côté Orchestrator dans deploy / run.
Les deux verbes nécessitent une session CLI active (uip login).
Toutes les sous-commandes respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard.
liste d’agents UIP
Répertoriez des solutions de Studio Web, éventuellement filtrées par un mot-clé.
Synthèse
uip agent list [-s <query>] [-l <n>] [--login-validity <minutes>]
uip agent list [-s <query>] [-l <n>] [--login-validity <minutes>]
Arguments
Aucun
Options
| Drapeau | Default | Objectif |
|---|---|---|
-s, --search <query> | — | Filtre de mots-clés appliqué au point de terminaison SearchSolutionsAndProjects de Studio Web. |
-l, --limit <n> | 20 | Nombre maximum de résultats. Envoyé comme paramètre de requête pagingOptions.limit . |
--login-validity <minutes> | 10 | Nombre minimum de minutes de validité du jeton requis. |
Exemples
# Simplest — list up to 20 solutions
uip agent list
# Filter by keyword
uip agent list --search invoice
# Page through larger result sets
uip agent list --limit 100
# Simplest — list up to 20 solutions
uip agent list
# Filter by keyword
uip agent list --search invoice
# Page through larger result sets
uip agent list --limit 100
Format des données (--sortie json)
{
"Code": "AgentList",
"Data": [
{
"Name": "Email Triage",
"Id": "a1b2c3d4-0000-0000-0000-000000000001",
"Status": "Completed",
"PublishStatus": "Published",
"LastModified": "2025-04-10T14:30:00Z",
"Projects": 2
}
]
}
{
"Code": "AgentList",
"Data": [
{
"Name": "Email Triage",
"Id": "a1b2c3d4-0000-0000-0000-000000000001",
"Status": "Completed",
"PublishStatus": "Published",
"LastModified": "2025-04-10T14:30:00Z",
"Projects": 2
}
]
}
Les ensembles de résultats vides produisent Data: { "Message": "No solutions found" } au lieu d’un tableau vide. Projects correspond au nombre de projets imbriqués dans la solution, et non dans une liste.
partage d’agents UIP
Gérer l’accès des utilisateurs et des groupes à une solution Studio Web. Trois sous-commandes: add, list et remove.
Synthèse
uip agent share add <solutionId> <entityId> [--permission <perm>] [--group] [--login-validity <minutes>]
uip agent share list <solutionId> [--login-validity <minutes>]
uip agent share remove <solutionId> <entityId> [--group] [--login-validity <minutes>]
uip agent share add <solutionId> <entityId> [--permission <perm>] [--group] [--login-validity <minutes>]
uip agent share list <solutionId> [--login-validity <minutes>]
uip agent share remove <solutionId> <entityId> [--group] [--login-validity <minutes>]
ajout de partage d’agent uip
Accordez l'accès à un utilisateur ou à un groupe.
Arguments
<solutionId>(requis) : UUID de la solution.<entityId>(requis) : UUID d’utilisateur ou de groupe.
Options
| Drapeau | Default | Objectif |
|---|---|---|
--permission <perm> | write | Niveau d’autorisation. L'un des suivants: none, read, write, publish, readWritePublish. Insensible à la casse; les valeurs non valides échouent avec une erreur de validation. |
--group | désactivé (utilisateur) | Traitez <entityId> comme un groupe plutôt que comme un utilisateur. |
--login-validity <minutes> | 10 | Nombre minimum de minutes de validité du jeton requis. |
Exemples
# Grant write access to a user
uip agent share add \
a1b2c3d4-0000-0000-0000-000000000001 \
a1b2c3d4-0000-0000-0000-000000000501 \
--permission write
# Grant read-only access to a group
uip agent share add <solutionId> <groupId> --permission read --group
# Full access (read + write + publish)
uip agent share add <solutionId> <userId> --permission readWritePublish
# Grant write access to a user
uip agent share add \
a1b2c3d4-0000-0000-0000-000000000001 \
a1b2c3d4-0000-0000-0000-000000000501 \
--permission write
# Grant read-only access to a group
uip agent share add <solutionId> <groupId> --permission read --group
# Full access (read + write + publish)
uip agent share add <solutionId> <userId> --permission readWritePublish
Data shape (--output json)
{
"Code": "AgentShare",
"Data": {
"Status": "Solution shared successfully",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"SharedWith": "a1b2c3d4-0000-0000-0000-000000000501",
"IsGroup": false,
"Permission": "write"
}
}
{
"Code": "AgentShare",
"Data": {
"Status": "Solution shared successfully",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"SharedWith": "a1b2c3d4-0000-0000-0000-000000000501",
"IsGroup": false,
"Permission": "write"
}
}
liste de partage d’agents uip
Répertoriez les utilisateurs et les groupes ayant accès à une solution.
Arguments
<solutionId>(requis) : UUID de la solution.
Options
Only --login-validity.
Exemple
uip agent share list a1b2c3d4-0000-0000-0000-000000000001
uip agent share list a1b2c3d4-0000-0000-0000-000000000001
Data shape (--output json)
{
"Code": "AgentShareList",
"Data": [
{
"Id": "a1b2c3d4-0000-0000-0000-000000000501",
"Name": "Jane Doe",
"Email": "jane@example.com",
"IsGroup": false,
"Permission": "write"
}
]
}
{
"Code": "AgentShareList",
"Data": [
{
"Id": "a1b2c3d4-0000-0000-0000-000000000501",
"Name": "Jane Doe",
"Email": "jane@example.com",
"IsGroup": false,
"Permission": "write"
}
]
}
Une réponse vide renvoie Data: { "Message": "No sharing permissions found for this solution" }.
Suppression du partage d’agents UIP
Révoquez l'accès d'un utilisateur ou d'un groupe.
Arguments
<solutionId>(requis) : UUID de la solution.<entityId>(requis) : UUID d’utilisateur ou de groupe.
Options
| Drapeau | Default | Objectif |
|---|---|---|
--group | désactivé (utilisateur) | Traitez <entityId> comme un groupe plutôt que comme un utilisateur. |
--login-validity <minutes> | 10 | Nombre minimum de minutes de validité du jeton requis. |
Exemple
uip agent share remove a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000501
uip agent share remove a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000501
Data shape (--output json)
{
"Code": "AgentShareRemove",
"Data": {
"Status": "Access removed successfully",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"RemovedEntity": "a1b2c3d4-0000-0000-0000-000000000501"
}
}
{
"Code": "AgentShareRemove",
"Data": {
"Status": "Access removed successfully",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"RemovedEntity": "a1b2c3d4-0000-0000-0000-000000000501"
}
}
Associé
uip agent push— importez un projet et obtenez leSolutionIdque vous utilisez ici.uip agent pull— téléchargez une solution répertoriée parlist.uip agent file— répertorie, télécharge et charge des fichiers dans les projets d’une solution.
Voir également
- Authentification — sessions, locataires et
--login-validity. - Options globales, codes de sortie.