categorías de uip ah, etiquetas, colaboradores, roles, usuarios

Sintaxis y opciones para la taxonomía de categorías de Automation Hub, etiquetas de texto libre, colaboradores por automatización, el catálogo de roles asignables y cuentas de usuario.

Las categorías son una taxonomía jerárquica en la que se colocan las automatizaciones; las etiquetas son etiquetas de texto libre. Los colaboradores son las personas que trabajan en una automatización, cada uno con uno o más roles : el catálogo de roles asignables de Automation Hub también es la forma en que uip ah users create concede acceso a todo el tenant. Consulta uip ah para conceptos compartidos (proyección/--all-fields, listas paginadas frente a listas no paginadas) que se aplican a cada verbo aquí.

categorías de UIP ah

Lee la jerarquía de categorías y coloca automatizaciones en ella.

Sinopsis

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 categorías obtener

Obtén la jerarquía de categorías como un árbol, con sus nombres de nivel. get, no list: el punto final devuelve un documento anidado, no una colección paginada — no hay --limit/--offset.

Opciones

Largo	Descripción
--all-fields	Devuelve la carga útil sin procesar en lugar de Levels/Categories.

Ejemplo

uip ah categories get

Forma de datos (--json de salida)

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

actualización de categorías de uip ah

Reemplaza todo el árbol de categorías desde un archivo. Automation Hub no tiene creación/eliminación por categoría: el árbol se sincroniza como un solo documento.

Opciones

Largo	Valor	Obligatorio	Descripción
--file <json-file>	Ruta	Sí	JSON con el árbol de categorías completo para sincronizar, en la forma que devuelve categories get.
-y, --yes	Marca	Sí	Confirme que esto reemplaza todo el árbol de categorías de tenant. Obligatorio: la CLI nunca solicita.

Un archivo vacío o claramente mal formado se rechaza en el lado del cliente antes de enviar la solicitud.

Ejemplo

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

Forma de datos (--json de salida)

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

conjunto de categorías de uip ah

Asigna una automatización a una categoría.

Argumentos

Nombre	Obligatorio	Propósito
<automation-id>	Sí	ID de automatización.

Opciones

Largo	Valor	Obligatorio	Descripción
--category-id <id>	Entero	Sí	ID de categoría a asignar.

Ejemplo

uip ah categories set 20 --category-id 4

Forma de datos (--json de salida)

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

etiquetas uip ah

Establece las etiquetas en una automatización.

conjunto de etiquetas ah uip

Reemplazar las etiquetas de una automatización con el conjunto dado: esto reemplaza toda la lista de etiquetas en lugar de fusionar (coincidencia con la semántica de reemplazo de uip config set).

Argumentos

Nombre	Obligatorio	Propósito
<automation-id>	Sí	ID de automatización.

Opciones

Largo	Valor	Obligatorio	Descripción
--tags <tag...>	Repetible	Sí	El conjunto completo de etiquetas para esta automatización.

Ejemplo

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

Forma de datos (--json de salida)

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

colaboradores de uip ah

Gestionar quién colabora en una automatización. Su propio grupo de recursos en lugar de un verbo en automations, por lo que los verbos CRUD estándar permanecen disponibles para él.

Sinopsis

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]

lista de colaboradores de uip ah

Opciones

Largo	Valor	Obligatorio	Descripción
--automation-id <id>	Entero	Sí	Automatización para leer (un parámetro de consulta en este punto final, no posicional).
--limit <n> / --offset <n>	Entero	No	Paginación, aplicada en el lado del cliente (punto final no paginado).
--all-fields	Marca	No	Devuelve la carga útil sin procesar.

Ejemplo

uip ah collaborators list --automation-id 20

Forma de datos (--json de salida)

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

creación de colaboradores de uip ah

Añade colaboradores a una automatización.

Argumentos

Nombre	Obligatorio	Propósito
<automation-id>	Sí	ID de automatización.

Opciones

Largo	Valor	Obligatorio	Descripción
--user-id <id...>	Repetible	Sí	ID de usuario para añadir.
--role-id <id...>	Repetible	Sí	ID de rol para otorgar a cada usuario añadido (aplicado a todos ellos: una división de roles por usuario necesita una llamada por usuario). Solo se aceptan los roles activos de tipo process; el punto final rechaza cualquier otro tipo.

Se requiere al menos un --role-id: el punto final rechaza una entrada de colaborador sin rol.

Ejemplo

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

Forma de datos (--json de salida)

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

eliminar colaboradores de uip ah

Elimine los roles de colaborador de los usuarios en una automatización. El punto final elimina las asignaciones de roles en lugar del registro de colaborador, por lo que --role-id es obligatorio: elimina todos los roles que tenga un usuario y dejará de ser un colaborador.

Argumentos

Nombre	Obligatorio	Propósito
<automation-id>	Sí	ID de automatización.

Opciones

Largo	Valor	Obligatorio	Descripción
--user-id <id...>	Repetible	Sí	ID de usuario de los que eliminar roles.
--role-id <id...>	Repetible	Sí	ID de rol para eliminar de cada usuario.
-y, --yes	Marca	Sí	Confirme esta operación irreversible. Obligatorio: la CLI nunca solicita.

Ejemplo

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

Forma de datos (--json de salida)

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

roles de uip ah

Descubre los roles de Automation Hub que se pueden asignar. Solo lectura.

lista de roles de uip ah

Opciones

Largo	Descripción
--limit <n> / --offset <n>	Paginación, aplicada en el lado del cliente (punto final no paginado).
--all-fields	Devuelve la carga útil sin procesar.

Ejemplo

uip ah roles list

Forma de datos (--json de salida)

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

Slug es el valor que toma uip ah users create --role; Id/Type son lo que collaborators create --role-id filtra (solo se aceptan los roles de Type: "process").

usuarios de uip ah

Gestionar usuarios de Automation Hub y sus roles.

Sinopsis

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...]

lista de usuarios de uip ah

Opciones

Largo	Valor	Descripción
--search <text>	String	Búsqueda de texto libre.
--sort-by <field>	String	Campo por el que ordenar, por ejemplo user_email.
--sort-order <direction>	asc|desc	Ordenar dirección.
--department <name> / --business-unit <name> / --location <name> / --job-title <title>	String	Filtros de ámbito.
--invite-status <status>	String	Solo este estado de invitación.
--role <slug>	String	Solo los usuarios que tienen este rol slug.
--limit <n> / --offset <n>	Entero	Paginación. Predeterminado --limit 20.
--all-fields	Marca	Devuelve la carga útil sin procesar.

Ejemplo

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

Forma de datos (--json de salida)

{
  "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 }
}

los usuarios de uip ah crean

Añade un usuario de Automation Cloud existente a Automation Hub. Esto importa un usuario que ya está en la organización: no puede invitar a uno nuevo y falla con un error de instrucción explícito si Automation Cloud desconoce la dirección.

Opciones

Largo	Valor	Obligatorio	Descripción
--email <email>	Correo electrónico	Sí	Dirección de correo electrónico del usuario.
--first-name <name> / --last-name <name>	String	condicionalmente	Requerido por el servicio en escritura (ver más abajo).
--job-title <title> / --department <name> / --business-unit <name> / --location <name>	String	condicionalmente	Requerido por el servicio al escribir.
--invite-status <status>	Entero	No	Código de estado de invitación numérico de Automation Hub. Valor predeterminado 2 al crear.
--active	Marca	No	Marcar el usuario como activo. Predeterminado al crear. Conflicto con --inactive.
--inactive	Marca	No	Marcar al usuario como inactivo. Conflicto con --active.
--role-id <id...>	Repetible	No	ID de rol a asignar (uip ah roles list para los ID).

Automation Hub requiere nueve campos para llevar un valor en cada escritura (email, first-name, last-name, business-unit, department, location, job-title, invite-status, active/inactive): en create, ninguno tiene un recurso alternativo almacenado, por lo que cualquier campo omitido falla en el lado del cliente al nombrar exactamente qué marcadores pasar.

Ejemplo

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

Forma de datos (--json de salida)

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

actualización de usuarios de uip ah

Actualizar un usuario, encontrado por --email. Automation Hub reemplaza todo el registro de usuario al escribir, por lo que los campos que no pasa se transfieren del registro almacenado, excepto que el servicio aún rechaza la escritura si cualquiera de los nueve campos obligatorios está vacío tanto en el marcador como en el registro almacenado .

Opciones

Los mismos marcadores que create, pero solo se requiere --email: el resto rellena los huecos del registro existente.

Ejemplo

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

Forma de datos (--json de salida)

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

Relacionado

• uip ah : descripción general, conceptos, audit-logs, auth-info.
• Automatizaciones, flujos de ideas, casos empresariales, fases, cuestionarios, procesos
• Aplicaciones, componentes, documentos, archivos multimedia, listados de Store, reseñas de Store

Ver también

• Herramientas (complementos)
• Opciones globales
• Códigos de salida