uip govs-policy

Syntaxe et options pour la politique CRUD de `uip gov aops-policy`, le catalogue de produits, le catalogue de types de licences et les commandes de modèle Form.io.

uip gov aops-policy gère les politiques de gouvernance UiPath AOps - les règles de configuration des produits (par exemple, une politique StudioX restreignant les paramètres de projet autorisés) créée en tant que formulaire Form.io rempli et attribuée aux locataires/utilisateurs/groupes. Cette page couvre le côté création: l’enregistrement de stratégie lui-même (list/get/create/update/delete), plus les catalogues de référence en lecture seule (product, license-type) et les commandes template qui génèrent le modèle de données de formulaire remplissables à partir duquel la charge utile data d'une politique est générée. Pour attribuer une stratégie à un sujet et résoudre ce qui s'applique réellement au moment de l'exécution, consultez aops-policy deployment et deployed-policy. Pour la vue d’ensemble de l’outil parent et les politiques d’accès, consultez uip gov.

Remarque :

Flux typique: template get <product> → modifiez le fichier form-data.json → policy create --product-name <product> --name <name> --input form-data.json → deployment tenant configure (ou utilisateur/groupe) pour le déployer.

Synthèse

uip gov aops-policy list [--product-name <name>] [--product-label <label>] [--search <term>] [--sort-by <field>] [--sort-order asc|desc] [--limit <n>] [--offset <n>]
uip gov aops-policy get <policyIdentifier>
uip gov aops-policy create --name <name> --product-name <name> [--description <text>] [--priority <n>] [--availability <n>] [--input <path>]
uip gov aops-policy update --identifier <id> --name <name> --product-name <name> [--description <text>] [--priority <n>] [--availability <n>] [--input <path>]
uip gov aops-policy delete <policyIdentifier>

uip gov aops-policy product list
uip gov aops-policy product get <productIdentifier>

uip gov aops-policy license-type list

uip gov aops-policy template get <productIdentifier> [--output-form-data <path>] [--output-template-locale-resource <path>]
uip gov aops-policy template list --output-dir <path>

Chaque verbe accepte également --login-validity <minutes> pour remplacer la durée de vie du jeton de connexion interactive pour cet appel (rament nécessaire).

liste uip govs-policy

Lister les politiques de gouvernance avec un filtrage et une pagination facultatifs. Renvoie les métadonnées de la politique (identifiant, nom, produit, priorité, disponibilité), et non l'objet blob data de politique.

Options

Long	Valeur (Value)	Description
--product-name <product-name>	string	Limitez-vous à un seul produit (par exemple, StudioX). Correspond à product.name — voir product list.
--product-label <productLabel>	string	Limitez à un seul produit par libellé d’affichage (par exemple 'Studio X'). Préférez --product-name pour les scripts.
--search <searchTerm>	string	Correspondance de sous-chaîne insensible à la casse par rapport au nom/à la description de la politique.
--sort-by <field>	string	Champ à utiliser pour trier (par exemple name, createdOn, priority). Transmis à l’API de gouvernance.
--sort-order <direction>	asc | desc	Sens de tri pour --sort-by. Insensible à la casse; toute autre valeur échoue côté client.
--limit <n>	Integer	Taille de la page. Par défaut 20.
--offset <n>	Integer	Index de page de base zéro.

Exemple

uip gov aops-policy list --product-name StudioX --limit 2

Format des données (--sortie json)

{
  "Code": "AopsPolicyList",
  "Data": [
    { "identifier": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Baseline StudioX Policy", "productName": "StudioX", "priority": 10, "availability": 1 }
  ]
}

uip gov aops-policy

Récupérez une stratégie par identifiant, y compris sa charge utile complète data (le modèle basé sur les données de formulaire remplies). Utiliser pour inspecter les valeurs soumises ou pour générer un update de suivi.

Arguments

Nom	Requis	Objectif
<policyIdentifier>	oui	GUID de stratégie, à partir de list.

Exemple

uip gov aops-policy get a1b2c3d4-0000-0000-0000-000000000001

Format des données (--sortie json)

{
  "Code": "AopsPolicyGet",
  "Data": {
    "identifier": "a1b2c3d4-0000-0000-0000-000000000001",
    "name": "Baseline StudioX Policy",
    "productName": "StudioX",
    "priority": 10,
    "availability": 1,
    "data": { "allowAnalytics": true, "maxProjects": 5 }
  }
}

Les clés de data sont conservées exactement telles qu'elles apparaissent dans le formulaire Form.io, et non PascalCase — cette charge utile est conçue pour effectuer un aller-retour dans update --input non modifié.

création de uip gov aops-policy

Créez une nouvelle politique de gouvernance pour un produit.

Options

Long	Valeur (Value)	Requis	Description
--name <name>	string	oui	Nom de la politique lisible par un humain (unique dans le produit).
--product-name <product-name>	string	oui	Produit cible (par exemple StudioX, AITrustLayer) — doit correspondre à un nom de product list.
--description <description>	string	non	Description en texte libre apparue dans l’interface utilisateur de gouvernance.
--priority <n>	Integer	non	Lorsque plusieurs politiques s’appliquent au même objet, les nombres plus élevés sont pris en compte.
--availability <n>	Integer	non	Indicateur de disponibilité (énumération spécifique au produit): vérifiez l’interface utilisateur de gouvernance ou les documents de service pour les valeurs valides.
--input <path>	Chemin d'accès	non	Fichier JSON avec l'objet de données de formulaire rempli (à partir de template get --output-form-data). Omit pour une stratégie sans charge utile de données.

Exemple

uip gov aops-policy create --name "Baseline StudioX Policy" --product-name StudioX --input form-data.json

Format des données (--sortie json)

{
  "Code": "AopsPolicyCreate",
  "Data": { "identifier": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Baseline StudioX Policy", "productName": "StudioX" }
}

La réponse fait écho à l'objet blob de données brutes (double-encapsulation), et non à la forme aplatie get renvoyée - utilisez get pour produire des données de formulaire pour un suivi update --input.

mise à jour aops-policy uip govs

Remplacez les champs d'une politique existante. Mise à jour complète, pas un correctif — chaque champ que vous souhaitez conserver doit être validé à nouveau; l'absence de --description/--priority/--availability/--input efface ce champ sur le serveur.

Options

Long	Valeur (Value)	Requis	Description
--identifier <identifier>	GUID	oui	Politique de mise à jour. De list/get.
--name <name>	string	oui	Nom de la politique. La transmission du nom existant le préserve.
--product-name <product-name>	string	oui	Doit correspondre au produit existant de la politique — la modification du produit lors de la mise à jour n'est pas prise en charge.
--description <description>	string	non	Remplacement complet: saisissez à nouveau la valeur existante de get afin de la conserver.
--priority <n>	Integer	non	Remplacement complet: saisissez à nouveau la valeur existante afin de la conserver.
--availability <n>	Integer	non	Remplacement complet: saisissez à nouveau la valeur existante afin de la conserver.
--input <path>	Chemin d'accès	non	Remplacement complet: saisissez à nouveau le data existant (enregistré à partir de get) pour le conserver.

Échec avec une « mise à niveau du modèle en cours »; si le modèle Form.io sous-jacent est en cours de migration — réessayez une fois qu'il est terminé.

Exemple

uip gov aops-policy update --identifier a1b2c3d4-0000-0000-0000-000000000001 --name "Baseline StudioX Policy" --product-name StudioX --input form-data.json

Format des données (--sortie json)

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

uip gov aops-policy - Autorisation

Supprimer définitivement une politique de gouvernance.

Remarque :

Échoue si la politique est toujours attribuée à un locataire/utilisateur/groupe. Exécutez d’abord deployment tenant\|user\|group remove sur chaque sujet, puis réessayez.

Arguments

Nom	Requis	Objectif
<policyIdentifier>	oui	GUID de stratégie, à partir de list.

Exemple

uip gov aops-policy delete a1b2c3d4-0000-0000-0000-000000000001

Format des données (--sortie json)

{ "Code": "AopsPolicyDelete", "Data": { "Status": "Deleted", "identifier": "a1b2c3d4-0000-0000-0000-000000000001" } }

produit uip govs-policy

Catalogue en lecture seule de produits qui publient des modèles de gouvernance. Utilisez pour découvrir des valeurs --product-name valides.

Liste de produits uip gov aops-policy

Exemple

uip gov aops-policy product list

Format des données (--sortie json)

{
  "Code": "AopsProductList",
  "Data": [
    { "identifier": "a1b2c3d4-0000-0000-0000-0000000000B1", "name": "StudioX", "label": "Studio X" }
  ]
}

name est ce à quoi s’attendent les entrées policy create --product-name, template get <productIdentifier> et deployment ... configure; label est le nom complet.

uip gov aops-policy obtenir

Arguments

Nom	Requis	Objectif
<productIdentifier>	oui	Nom du produit (par ex. StudioX) ou GUID — soit name, soit identifier à partir de product list.

Exemple

uip gov aops-policy product get StudioX

Format des données (--sortie json)

{ "Code": "AopsProductGet", "Data": { "identifier": "a1b2c3d4-0000-0000-0000-0000000000B1", "name": "StudioX", "label": "Studio X" } }

uip gov aops-policy license-type

Catalogue de types de licences en lecture seule (par ex. Attended, Unattended) — utilisé pour définir l'étendue des entrées deployment tenant configure et comme argument <license-type> pour deployed-policy get/list.

uip gov aops-policy - liste des types de licence

Exemple

uip gov aops-policy license-type list

Format des données (--sortie json)

{
  "Code": "AopsLicenseTypeList",
  "Data": [
    { "identifier": "a1b2c3d4-0000-0000-0000-0000000000A1", "name": "Attended" },
    { "identifier": "a1b2c3d4-0000-0000-0000-0000000000A2", "name": "Unattended" }
  ]
}

Le identifier alimente deployment tenant configure entrées; l'affichage name est ce que deployed-policy get/list accepte comme <license-type>.

modèle uip govs-policy

Génère le plan de données de formulaire remplissable (et une référence lisible par un humain) à partir du modèle de politique Form.io d'un produit — la source de la charge utile data d'une politique.

uip gov aops-policy template obtenir

Récupérez le modèle Form.io actif d'un produit et émettez des artefacts de politique.

Arguments

Nom	Requis	Objectif
<productIdentifier>	oui	Nom ou identifiant du produit (par ex. StudioX).

Options

Long	Valeur (Value)	Description
--output-form-data <path>	Chemin d'accès	Écrivez le modèle de données de formulaire JSON — l'objet que vous modifiez et soumettez à nouveau le create/update. Les composants en mode affichage uniquement (masqués, bouton, soumission, HTML, contenu) sont ignorés; les feuilles manquantes reçoivent des valeurs par défaut appropriées au type (false pour la case à cocher, [] pour la grille d'édition, {} pour les cases de sélection, null pour le texte/sélectionner).
--output-template-locale-resource <path>	Chemin d'accès	Écrivez une référence lisible par un humain résolue dans la région: chaque clé locale au niveau du produit est remplacée par sa chaîne anglaise (par exemple, <prop>-key préservant l'original), et defaultData.data devient une carte annotée plate ({ value, type, label, description?, tooltip? }). Préfixes entre produits (par exemple AutomationOps.submit) ne sont pas résolus.

Si aucun indicateur --output-* n'est transmis, le modèle et les données de formulaire sont renvoyés dans la charge utile stdout Data à la place.

Exemple

uip gov aops-policy template get StudioX --output-form-data form-data.json --output-template-locale-resource reference.json

Format des données (--sortie json)

{
  "Code": "AopsPolicyTemplateGet",
  "Data": {
    "formDataFile": "/Users/alice/aops/form-data.json",
    "templateLocaleResourceFile": "/Users/alice/aops/reference.json"
  }
}

Lorsqu'aucun indicateur --output-* n'est transmis, Data contient template (le DTO brut Form.io) et formData ( le modèle) directement — les deux préservent leur casse native Form.io plutôt que d'être PascalCase, de sorte formData allers-retours dans create/update --input élément textuel.

Une UnsupportedTemplateComponentError (le modèle du produit utilise un type de composant que la CLI ne peut pas convertir) échoue avec ErrorCode: "configuration_error" et Retry: "RetryWillNotFix" — auteur de la politique data manuellement dans ce cas.

Liste de modèles uip gov aops-policy

Récupérer le modèle de chaque produit et vider un ensemble complet d'artefacts par produit — utiliser au lieu d'une boucle template get.

Options

Long	Valeur (Value)	Requis	Description
--output-dir <path>	Chemin d'accès	oui	Répertoire sous lequel un <ProductName>/ dossier par produit (contenu form-template.json, form-data.json, form-template-locale-resource.json) est créé.

Les échecs par produit sont collectés et n'interrompent pas l'exécution — la commande se termine non-zéro uniquement si tous les produits échouent.

Exemple

uip gov aops-policy template list --output-dir ./aops-templates

Format des données (--sortie json)

{
  "Code": "AopsPolicyTemplateList",
  "Data": {
    "outputDir": "/Users/alice/aops-templates",
    "results": [
      {
        "productName": "StudioX",
        "status": "Success",
        "templateFile": "/Users/alice/aops-templates/StudioX/form-template.json",
        "formDataFile": "/Users/alice/aops-templates/StudioX/form-data.json",
        "templateLocaleResourceFile": "/Users/alice/aops-templates/StudioX/form-template-locale-resource.json"
      }
    ]
  }
}

L'entrée d'un produit ayant échoué contient les champs status: "Failure" et message au lieu des trois chemins de fichiers.

Associé

• uip gov — Présentation de l’outil et Politiques d’accès.
• aops-policy deployment et deployed-policy — affecter des politiques aux locataires/utilisateurs/groupes, résoudre la politique effective.
• compliance-packs — regroupent les stratégies dans une infrastructure nommée.

Voir également

• Outils (extensions)
• Options globales
• Codes de sortie