UiPath Documentation
uipath-cli
latest
false
Guide de l'utilisateur de UiPath CLI
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.

Gouvernance de l’UIP

Gérer la gouvernance UiPath — Politiques AOps, Politiques d'accès et Packs de conformité — à l'aide de l'outil `uip gov`.

uip gov est l'outil de gouvernance: il gère trois interfaces de gouvernance distinctes sous une même CLI — Politiques AOps (limites de configuration des produits appliquées par les produits UiPath comme StudioX), politiques d'accès (qui/ce qui peut invoquer un agent, un flux ou une autre ressource agentique) et les packs de conformité (ensembles de politiques AOps/Access mappées à une infrastructure de conformité nommée, comme ISO 42001, qui peut être activée pour un locataire en une seule étape). Installez-le avec uip tools install gov, ou invoquez uip gov … et laissez l'installation automatique s'exécuter. Voir Outils pour le modèle d'installation.

L'outil est fourni sous la forme du package @uipath/gov-tool, et sa surface de commande est divisée sur cette page et deux pages frères en raison de sa taille.

Cette ressource s’étend sur quatre pages​

  • Cette page — concepts, et access-policy .
  • aops-policy — stratégie CRUD, product, license-type, template.
  • aops-policy deployment et deployed-policy — affecter des politiques aux locataires/utilisateurs/groupes et résoudre la politique effective au moment de l'exécution.
  • compliance-packs — catalog (parcourir) et state (activation/désactivation/couverture par locataire).

Concepts​

  • Politiques AOps vs. Politiques d’accès - il s’agit de deux systèmes indépendants avec leurs propres API, formes de données et verbes; ce ne sont pas des variantes de la même ressource. Les politiques AOps contraignent la configuration du produit (par exemple, une politique StudioX limitant les paramètres de projet autorisés) et sont étendues par l’héritage de productName/licenseType/tenant-user-group. Les politiques d'accès contraignent les personnes qui peuvent invoquer une ressource (par exemple, les acteurs qui peuvent invoquer un agent donné) et sont évaluées par un point de décision de politique par rapport à un contexte de demande en direct.
  • Les packs de conformité relient les deux : un pack regroupe un ensemble de politiques AOps prédéfinies (et éventuellement des politiques d'accès) mappées aux clauses d'un cadre nommé (ISO 42001, etc.). L'activation d'un pack déploie ses stratégies sur Aops en un seul appel au lieu de les créer manuellement.
  • Données de référence en lecture seule - product, license-type et le package de conformité catalog sont en lecture seule: elles existent pour découvrir les valeurs valides pour les commandes de mutating (--product-name, identifiants de type de licence, packId), ne doivent pas être modifiés via la CLI.

Synthèse​

uip gov access-policy list [--limit <n>] [--offset <n>] [--filter <odata>] [--sort-by <field> asc|desc]
uip gov access-policy get <policyId>
uip gov access-policy create --file <path>
uip gov access-policy update --file <path>
uip gov access-policy delete <policyId...>
uip gov access-policy evaluate --resource-type <type> [--resource-id <id>] [--actor-identity-id <id>] [--actor-process-type <type>] [--actor-process-id <id>] [--folder-key <key>] [--trace-parent-id <id>]
uip gov access-policy list [--limit <n>] [--offset <n>] [--filter <odata>] [--sort-by <field> asc|desc]
uip gov access-policy get <policyId>
uip gov access-policy create --file <path>
uip gov access-policy update --file <path>
uip gov access-policy delete <policyId...>
uip gov access-policy evaluate --resource-type <type> [--resource-id <id>] [--actor-identity-id <id>] [--actor-process-type <type>] [--actor-process-id <id>] [--folder-key <key>] [--trace-parent-id <id>]

politique d’accès uip gov​

Gérer les politiques d’accès de bout en bout. Deux services de sauvegarde sont encapsulés: le point d'administration de la politique pour list/get/create/update/delete sur les enregistrements de politique, et le point de décision de politique pour evaluate, qui résout la décision Autoriser/Refuser efficace dans un contexte de demande concret.

Remarque :

Flux typique: créer un PolicyDefinition JSON → create --file ... → evaluate --resource-type <type> (avec d'autres indicateurs de contexte) pour confirmer que la stratégie prend effet → itérer avec update --file ....

liste politique d’accès uip gov​

Recherchez des stratégies avec un filtrage et une pagination OData facultatifs.

Options​
LongValeur (Value)DefaultDescription
--limit <n>entier non négatif20Taille de la page — Nombre maximal de stratégies à renvoyer.
--offset <n>entier non négatif0Enregistrements à ignorer avant la page renvoyée.
--filter <filter>Expression OData—P. ex. : "status in ('Active')".
--sort-by <order><Field> asc|desc—Par exemple "Name asc", "CreatedOn desc".
--login-validity <minutes>entier non négatif—Remplacez la durée de vie du jeton de connexion interactive pour cet appel.
Exemple​
uip gov access-policy list --filter "status in ('Active')" --sort-by "Name asc"
uip gov access-policy list --filter "status in ('Active')" --sort-by "Name asc"
Format des données (--sortie json)​
{
  "Code": "PolicyList",
  "Data": {
    "totalCount": 1,
    "results": [
      { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Agent Governance", "status": "Active" }
    ]
  }
}
{
  "Code": "PolicyList",
  "Data": {
    "totalCount": 1,
    "results": [
      { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Agent Governance", "status": "Active" }
    ]
  }
}

uip gov - politique d’accès - Obtenir​

Récupérez la valeur PolicyDefinition complète d'une stratégie par UUID — à utiliser pour inspecter les sélecteurs/Règles/Application, ou pour référencer une update.

Arguments​
NomRequisObjectif
<policyId>ouiUUID de la stratégie, à partir de access-policy list.
Exemple​
uip gov access-policy get a1b2c3d4-0000-0000-0000-000000000001
uip gov access-policy get a1b2c3d4-0000-0000-0000-000000000001
Format des données (--sortie json)​
{
  "Code": "PolicyGet",
  "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Agent Governance", "status": "Active" }
}
{
  "Code": "PolicyGet",
  "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Agent Governance", "status": "Active" }
}

Création de politique d’accès uip gov​

Créez une nouvelle stratégie d’accès à partir d’un fichier JSON conforme à PolicyDefinition. Envoyé tel quel (pas d'encapsulage): n'incluez pas un idattribué par le serveur.

Options​
LongValeur (Value)RequisDescription
--file <path>Chemin d'accèsouiFichier JSON contenant le PolicyDefinition à créer.
--login-validity <minutes>entier non négatifnonRemplacer la durée de vie du jeton de connexion interactive.

Un nom en conflit avec une politique existante échoue l'appel - vérifiez d'abord access-policy list.

Exemple​
uip gov access-policy create --file ./policy.json
uip gov access-policy create --file ./policy.json
Format des données (--sortie json)​
{
  "Code": "PolicyCreated",
  "Data": {
    "statusCode": 200,
    "errors": null,
    "upsertedPolicy": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Agent Governance", "status": "Active" }
  }
}
{
  "Code": "PolicyCreated",
  "Data": {
    "statusCode": 200,
    "errors": null,
    "upsertedPolicy": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Agent Governance", "status": "Active" }
  }
}

Capturez upsertedPolicy.id pour les appels de suivi evaluate/update/delete.

mise à jour de la politique d’accès de uip gov​

Mettez à jour une stratégie d'accès existante depuis un fichier JSON. Envoyé en tant que HTTP PATCH — le fichier doit inclure le id de la stratégie.

Options​
LongValeur (Value)RequisDescription
--file <path>Chemin d'accèsouiFichier JSON avec le fichier PolicyDefinition mis à jour (doit inclure id).
--login-validity <minutes>entier non négatifnonRemplacer la durée de vie du jeton de connexion interactive.

Pour référencer le fichier: access-policy get <id>, modifiez le fichier JSON, renvoyez-le via --file.

Exemple​
uip gov access-policy update --file ./policy.json
uip gov access-policy update --file ./policy.json
Format des données (--sortie json)​

Même forme que create, avec Code: "PolicyUpdated".

suppression de la politique d’accès uip gov​

Supprimez une ou plusieurs stratégies d’accès par UUID dans une seule requête. permanent — aucune suppression temporaire/annulation.

Arguments​
NomRequisObjectif
<policyId...>ouiUne ou plusieurs UUID de politique, séparés par des espaces.
Exemple​
uip gov access-policy delete a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002
uip gov access-policy delete a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000002
Format des données (--sortie json)​
{ "Code": "PolicyDeleted", "Data": { "PolicyIds": ["a1b2c3d4-0000-0000-0000-000000000001", "a1b2c3d4-0000-0000-0000-000000000002"] } }
{ "Code": "PolicyDeleted", "Data": { "PolicyIds": ["a1b2c3d4-0000-0000-0000-000000000001", "a1b2c3d4-0000-0000-0000-000000000002"] } }

Évaluation de la politique d’accès uip gov​

Demandez au PDP de résoudre la décision Autoriser/Refuser efficace pour un contexte de demande - prévisualisez ce qu'un acteur verra avant le déploiement ou déboguez un refus de production. Nécessite le contexte du locataire (la connexion doit cibler un locataire spécifique, et pas seulement une organisation).

Options​
LongValeur (Value)RequisDescription
--resource-type <type>l’un des Agent, AgenticProcess, RPAWorkflow, APIWorkflow, CaseManagement, FlowouiLa ressource protégée en cours d'accès.
--resource-id <id>stringnonIdentificateur de l'instance de ressource spécifique (par exemple, UUID d'un agent).
--actor-identity-id <id>stringnonIdentifiant d’acteur — requis uniquement avec un jeton S2S; avec un jeton d'utilisateur, l'acteur est déduit du porteur.
--actor-process-type <type>Un de Agent, AgenticProcess, CaseManagement, FlownonLe workflow/l'agent exécuté au nom de l'acteur, le cas échéant.
--actor-process-id <id>stringnonIdentificateur de cet exécutable (par exemple, un UUID de flux).
--folder-key <key>UUIDnonClé de dossier étendant la requête.
--trace-parent-id <id>stringnonValeur W3C traceparent pour corréler cette évaluation avec les traçages en amont.
--login-validity <minutes>entier non négatifnonRemplacer la durée de vie du jeton de connexion interactive.

Échoue avec un « contexte de locataire » clair Si le client ne peut pas résoudre un ID de locataire à partir de la connexion actuelle.

Exemple​
uip gov access-policy evaluate --resource-type Agent
uip gov access-policy evaluate --resource-type Agent
Format des données (--sortie json)​
{
  "Code": "PolicyEvaluated",
  "Data": { "enforcement": "Allow", "evaluationDetails": null, "effectivePolicies": [] }
}
{
  "Code": "PolicyEvaluated",
  "Data": { "enforcement": "Allow", "evaluationDetails": null, "effectivePolicies": [] }
}

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