catégories uip ah, balises, collaborateurs, rôles, utilisateurs

Syntaxe et options pour la taxonomie de la catégorie Automation Hub, les balises en texte libre, les collaborateurs par automatisation, le catalogue de rôles attribuable et les comptes d'utilisateurs.

Les catégories sont une taxonomie hiérarchique dans laquelle les automatisations sont placées; les balises sont des libellés en texte libre. Les collaborateurs sont les personnes travaillant sur une automatisation, chacune ayant un ou plusieurs rôles - Le catalogue de rôles attribuables d'Automation Hub est également la façon dont uip ah users create accorde l'accès à l'échelle du locataire. Voir uip ah pour les concepts partagés (projection/--all-fields, listes pages par rapport aux listes non pages) qui s'appliquent à chaque verbe ici.

catégories uip ah

Lisez la hiérarchie des catégories et placez-y les automatisations.

Synthèse

uip ah categories get [--all-fields]
uip ah categories update --file <json-file> [-y, --yes]
uip ah categories set <automation-id> --category-id <id>

uip ah catégories - Obtenir

Obtenez la hiérarchie des catégories sous la forme d'une même arborescence, avec ses noms de niveau. get, non list: le point de terminaison renvoie un document imbriqué, et non une collection de pages — il n'y a pas de --limit/--offset.

Options

Long	Description
--all-fields	Renvoyez la charge utile brute au lieu de Levels/Categories.

Exemple

uip ah categories get

Format des données (--sortie json)

{
  "Code": "AhCategoriesGet",
  "Data": { "Levels": [{ "Id": 1, "Name": "Business Unit" }], "Categories": [{ "Id": 4, "Name": "Finance" }] }
}

mise à jour des catégories uip ah

Remplacez l'ensemble de l'arborescence des catégories à partir d'un fichier. Automation Hub ne permet pas de créer/supprimer par catégorie — l'arborescence est synchronisée en un seul document.

Options

Long	Valeur (Value)	Requis	Description
--file <json-file>	Chemin d'accès	oui	JSON avec l'arborescence complète des catégories à synchroniser, sous la forme categories get.
-y, --yes	Drapeau	oui	Confirmez que cela remplace l’ensemble de l’arborescence des catégories de locataires. Requis — la CLI ne s'affiche jamais.

Un fichier vide ou clairement mal formé est rejeté côté client avant l'envoi de la demande.

Exemple

uip ah categories update --file ./categories.json --yes

Format des données (--sortie json)

{ "Code": "AhCategoriesUpdate", "Data": { "Status": "Synced" } }

ensemble de catégories uip ah

Attribuez une automatisation à une catégorie.

Arguments

Nom	Requis	Objectif
<automation-id>	oui	Identifiant de l’automatisation.

Options

Long	Valeur (Value)	Requis	Description
--category-id <id>	Integer	oui	Identifiant de la catégorie à attribuer.

Exemple

uip ah categories set 20 --category-id 4

Format des données (--sortie json)

{ "Code": "AhCategoriesSet", "Data": { "AutomationId": 20, "CategoryId": 4 } }

balises uip ah

Définissez les balises sur une automatisation.

ensemble de balises uip ah

Remplacez les balises d’une automatisation par l’ensemble donné — cela remplace la liste entière de balises plutôt que la fusion (correspondance de la sémantique de remplacement de uip config set).

Arguments

Nom	Requis	Objectif
<automation-id>	oui	Identifiant de l’automatisation.

Options

Long	Valeur (Value)	Requis	Description
--tags <tag...>	Répétable	oui	L’ensemble de balises de cette automatisation.

Exemple

uip ah tags set 20 --tags finance "quick win"

Format des données (--sortie json)

{ "Code": "AhTagsSet", "Data": { "AutomationId": 20, "Tags": ["finance", "quick win"] } }

collaborateurs uip ah

Gérer qui contribue à une automatisation. Son propre groupe de ressources plutôt qu'un verbe sur automations, de sorte que les verbes CRUD standard restent disponibles.

Synthèse

uip ah collaborators list --automation-id <id> [--limit <n>] [--offset <n>] [--all-fields]
uip ah collaborators create <automation-id> --user-id <id...> --role-id <id...>
uip ah collaborators delete <automation-id> --user-id <id...> --role-id <id...> [-y, --yes]

liste des collaborateurs uip ah

Options

Long	Valeur (Value)	Requis	Description
--automation-id <id>	Integer	oui	Automatisation à lire (un paramètre de requête sur ce point de terminaison, pas un paramètre).
--limit <n> / --offset <n>	Integer	non	Pagination appliquée côté client (point de terminaison non paginé).
--all-fields	Drapeau	non	Renvoyez la charge utile brute.

Exemple

uip ah collaborators list --automation-id 20

Format des données (--sortie json)

{
  "Code": "AhCollaboratorsList",
  "Data": [
    { "Id": 1, "Email": "[e-mail]", "FirstName": "Jane", "LastName": "Doe", "JobTitle": "Analyst", "Department": "Finance", "BusinessUnit": "EMEA", "IsActive": 1 }
  ]
}

création de collaborateurs uip ah

Ajouter des collaborateurs à une automatisation.

Arguments

Nom	Requis	Objectif
<automation-id>	oui	Identifiant de l’automatisation.

Options

Long	Valeur (Value)	Requis	Description
--user-id <id...>	Répétable	oui	ID d'utilisateur à ajouter.
--role-id <id...>	Répétable	oui	ID de rôle à accorder à chaque utilisateur ajouté (appliqué à chacun d’eux — un fractionnement de rôle par utilisateur nécessite un appel par utilisateur). Seuls les rôles actifs de type process sont acceptés; le point de terminaison rejette tout autre type.

Au moins un --role-id est requis — le point de terminaison rejette une entrée de collaborateur sans rôle.

Exemple

uip ah collaborators create 20 --user-id 3 --role-id 3

Format des données (--sortie json)

{ "Code": "AhCollaboratorsCreate", "Data": { "AutomationId": 20, "UserIds": [3] } }

suppression des collaborateurs uip ah

Supprimez les rôles de collaborateur des utilisateurs sur une automatisation. Le point de terminaison supprime les attributions de rôle plutôt que l'enregistrement du collaborateur. Ainsi, --role-id est requis. Supprimez chaque rôle détenu par un utilisateur et il cesse d'être un collaborateur.

Arguments

Nom	Requis	Objectif
<automation-id>	oui	Identifiant de l’automatisation.

Options

Long	Valeur (Value)	Requis	Description
--user-id <id...>	Répétable	oui	Identifiants d'utilisateur desquels supprimer les rôles.
--role-id <id...>	Répétable	oui	ID de rôle à supprimer de chaque utilisateur.
-y, --yes	Drapeau	oui	Confirmez cette opération irréversible. Requis — la CLI ne s'affiche jamais.

Exemple

uip ah collaborators delete 20 --user-id 3 --role-id 3 --yes

Format des données (--sortie json)

{ "Code": "AhCollaboratorsDelete", "Data": { "AutomationId": 20, "UserIds": [3], "RoleIds": [3] } }

rôles uip ah

Découvrez les rôles Automation Hub qui peuvent être attribués. En lecture seule.

liste des rôles uip ah

Options

Long	Description
--limit <n> / --offset <n>	Pagination appliquée côté client (point de terminaison non paginé).
--all-fields	Renvoyez la charge utile brute.

Exemple

uip ah roles list

Format des données (--sortie json)

{
  "Code": "AhRolesList",
  "Data": [
    { "Id": 2, "Name": "System Admin", "Slug": "ah-system-admin", "Type": "service", "Description": "...", "IsActive": 1, "IsDefault": 0 }
  ]
}

Slug est la valeur que prend uip ah users create --role; Id/Type sont les filtres collaborators create --role-id (seules Type: "process" rôles y sont acceptés).

utilisateurs uip ah

Gérer les utilisateurs d’Automation Hub et leurs rôles.

Synthèse

uip ah users list [--search <text>] [--sort-by <field>] [--sort-order asc|desc] [--department <name>] [--business-unit <name>] [--location <name>] [--job-title <title>] [--invite-status <status>] [--role <slug>] [--limit <n>] [--offset <n>] [--all-fields]
uip ah users create --email <email> [write options...] --role-id <id...>
uip ah users update --email <email> [write options...]

liste des utilisateurs uip ah

Options

Long	Valeur (Value)	Description
--search <text>	string	Recherche en texte libre.
--sort-by <field>	string	Champ à utiliser pour le tri, par exemple user_email.
--sort-order <direction>	asc|desc	Choisir l'ordre de tri.
--department <name> / --business-unit <name> / --location <name> / --job-title <title>	string	Filtres d'étendue.
--invite-status <status>	string	Uniquement ce statut d'invitation.
--role <slug>	string	Uniquement les utilisateurs ayant ce rôle, champ de données dynamique.
--limit <n> / --offset <n>	Integer	Pagination. Par défaut --limit 20.
--all-fields	Drapeau	Renvoyez la charge utile brute.

Exemple

uip ah users list --department Finance --limit 20

Format des données (--sortie json)

{
  "Code": "AhUsersList",
  "Data": [
    { "Id": 3, "Email": "[e-mail]", "FirstName": "Jane", "LastName": "Doe", "JobTitle": "Analyst", "Department": "Finance", "BusinessUnit": "EMEA", "Location": "Boston", "IsAdmin": 0, "IsActive": 1, "InviteStatus": 2, "AutomationCount": 3 }
  ],
  "Pagination": { "Returned": 1, "Limit": 20, "Offset": 0 }
}

création d'utilisateurs uip ah

Ajouter un utilisateur Automation Cloud existant à Automation Hub. Cela importe un utilisateur qui fait déjà partie de l’organisation; il ne peut pas en inviter un nouveau et échoue avec une erreur d’instruction explicite si l’adresse est inconnue d’Automation Cloud.

Options

Long	Valeur (Value)	Requis	Description
--email <email>	E-mail	oui	Adresse e-mail de l'utilisateur.
--first-name <name> / --last-name <name>	string	Conditionnel	Requis par le service d'écriture (voir ci-dessous).
--job-title <title> / --department <name> / --business-unit <name> / --location <name>	string	Conditionnel	Requis par le service lors de l'écriture.
--invite-status <status>	Integer	non	Code de statut d’invitation Automation Hub numérique. 2 par défaut lors de la création.
--active	Drapeau	non	Marquez l’utilisateur actif. Par défaut lors de la création. Conflit avec --inactive.
--inactive	Drapeau	non	Marquez l’utilisateur inactif. Conflit avec --active.
--role-id <id...>	Répétable	non	ID de rôle à attribuer (uip ah roles list pour les ID).

Automation Hub nécessite neuf champs pour transmettre une valeur à chaque écriture (email, first-name, last-name, business-unit, department, location, job-title, invite-status, active/inactive) — sur create, aucun ne dispose d'une solution de secours stockée, de sorte que tout champ omis ne parvient pas à nommer exactement les indicateurs à transmettre.

Exemple

uip ah users create --email [e-mail] --first-name Jane --last-name Doe \
  --job-title Analyst --department Finance --business-unit EMEA --location Boston --role-id 3

Format des données (--sortie json)

{ "Code": "AhUsersCreate", "Data": { "Email": "[e-mail]", "Status": "Created" } }

mise à jour des utilisateurs uip ah

Mettre à jour un utilisateur, trouvé par --email. Automation Hub remplace l'ensemble de l'enregistrement de l'utilisateur lors de l'écriture, de sorte que les champs que vous ne transmettez pas sont reportés à partir de l'enregistrement stocké, sauf que le service rejette toujours l'écriture si l'un des neuf champs requis est vide à la fois sur l'indicateur et l'enregistrement stocké .

Options

Mêmes indicateurs que create, mais seul --email est requis, les autres remplissant les écarts de l'enregistrement existant.

Exemple

uip ah users update --email [e-mail] --job-title 'Senior Analyst'

Format des données (--sortie json)

{ "Code": "AhUsersUpdate", "Data": { "Email": "[e-mail]", "Status": "Updated" } }

Associé

• uip ah — vue d'ensemble, concepts, audit-logs, auth-info.
• Automatisations, flux d'idées, cas métier, phases, questionnaires, pipelines
• Applications, composants, documents, médias, listes de magasins, avis en magasin

Voir également

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