uip o usuarios

Sintaxis y opciones para `uip o usuarios`, que gestiona los usuarios del tenant de Orchestrator y sus asignaciones de carpetas y roles.

uip or users gestiona los usuarios de Orchestrator en el nivel de tenant. Los usuarios de Orchestrator están respaldados por Identity Service (IS): esta herramienta no crea usuarios independientes desde cero. En su lugar, users import hace referencia a un director de directorio de IS existente (un usuario, grupo, cuenta de robot o aplicación externa) y lo aprovisiona en el tenant; users update luego edita las propiedades del tenant (licencia, permisos de sesión, credenciales unattended) que se encuentran en el lado de Orchestrator. No hay users delete: la eliminación de usuarios se gestiona a través de Identity Service o el portal de Orchestrator, no de esta CLI. Para la gestión de roles a nivel de carpeta, consulta uip or roles.

Sinopsis

uip or users list [options]
uip or users list-in-folder [--folder-path <path> | --folder-key <key>] [options]
uip or users list-available [--folder-path <path> | --folder-key <key>] [options]
uip or users get <user-key>
uip or users import (--username <name> | --directory-id <id>) --type <type> [--folder-path <path> | --folder-key <key>] [--role-keys <keys>]
uip or users assign --user-key <key> [--folder-path <path> | --folder-key <key>] [--role-keys <keys>]
uip or users unassign --user-key <key> [--folder-path <path> | --folder-key <key>]
uip or users update <user-key> [options]
uip or users current
uip or users assign-roles <user-key> --role-keys <keys>

Verbos

Verbo	Propósito
list	Enumerar usuarios de tenant con filtros opcionales.
list-in-folder	Enumera los usuarios asignados a una carpeta, con sus roles en el nivel de carpeta.
list-available	Enumerar los usuarios que aún se pueden asignar a una carpeta (aún no asignados).
get	Obtener un usuario por clave.
import	Importa un director de directorio de Identity Service existente en el tenant.
assign	Asigna un usuario a una carpeta, opcionalmente con roles en el nivel de carpeta.
unassign	Eliminar un usuario de una carpeta.
update (alias edit)	Actualizar las propiedades del lado del tenant de un usuario (semántica PATCH).
current	Devuelve los detalles del usuario actualmente autenticado.
assign-roles	Reemplaza las asignaciones de roles en el nivel de tenant de un usuario.

uip o lista de usuarios

Enumerar usuarios en el tenant. Devuelve la clave de usuario (GUID), nombre de usuario, nombre completo, correo electrónico, tipo y estado activo.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--key	GUID	—	Filtrar por clave de usuario (coincidencia exacta).
—	--username	text	—	Filtrar por nombre de usuario (contiene coincidencias).
—	--email	text	—	Filtrar por dirección de correo electrónico (contiene coincidencias).
-l	--limit	Número	50	Tamaño de la página.
—	--offset	Número	0	Omitir recuento.
—	--sort-by	Campo	—	Ordenación de OData (por ejemplo, UserName asc).
—	--all-fields	Marca	Desactivado	Devuelve la carga útil de la API completa en lugar del resumen seleccionado.

Ejemplos

uip or users list --limit 10
uip or users list --username admin
uip or users list --output-filter 'Data[].{key:Key, name:UserName}'

Forma de datos (--json de salida)

{
  "Code": "UserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "[e-mail]",
      "FullName": "Admin User",
      "Email": "[e-mail]",
      "Type": "User",
      "IsActive": true
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0 }
}

uip o lista en carpeta de usuarios

Enumera los usuarios asignados a una carpeta, con sus roles en el nivel de carpeta. Requiere --folder-path o --folder-key.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--folder-path	Ruta	—	Carpeta de destino. Proporciona esto o --folder-key.
—	--folder-key	GUID	—	Carpeta de destino. Proporciona esto o --folder-path.
—	--include-inherited	Marca	Desactivado	Mostrar también los usuarios heredados de las carpetas principales.
-l	--limit	Número	50	Tamaño de la página.
—	--offset	Número	0	Omitir recuento.
—	--sort-by	Campo	Id desc	Ordenación de OData.
—	--all-fields	Marca	Desactivado	Devuelve la carga útil de la API completa en lugar del resumen seleccionado.

Ejemplos

uip or users list-in-folder --folder-path "Shared"
uip or users list-in-folder --folder-path "Shared" --include-inherited
uip or users list-in-folder --folder-path "Shared" \
    --output-filter 'Data[].{name:UserName, roles:Roles}'

Forma de datos (--json de salida)

{
  "Code": "UserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "[e-mail]",
      "FullName": "Admin User",
      "Type": "User",
      "IsInherited": false,
      "Roles": "Folder Administrator"
    }
  ]
}

uip o lista de usuarios disponible

Enumera los usuarios de tenant que aún se pueden asignar a una carpeta. Usa las claves devueltas con users assign o roles assign.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--folder-path	Ruta	—	Carpeta de destino. Proporciona esto o --folder-key.
—	--folder-key	GUID	—	Carpeta de destino. Proporciona esto o --folder-path.
-s	--search	text	—	Filtrar por nombre de usuario (contiene coincidencias).
-l	--limit	Número	50	Tamaño de la página.
—	--offset	Número	0	Omitir recuento.

Ejemplos

uip or users list-available --folder-path "Shared"
uip or users list-available --folder-path "Shared" --search admin
uip or users list-available --folder-path "Shared" \
    --output-filter 'Data[].Key'

Forma de datos (--json de salida)

{
  "Code": "UserAvailableList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000003",
      "UserName": "[e-mail]",
      "Roles": ""
    }
  ]
}

uip o los usuarios obtienen

Obtener un usuario por clave GUID.

Argumentos

Nombre	Obligatorio	Propósito
<user-key>	Sí	Clave de usuario (GUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--all-fields	Marca	Desactivado	Devuelve la carga útil de la API completa en lugar del resumen seleccionado.

Ejemplos

uip or users get d4e5f6a7-0000-0000-0000-000000000001
uip or users get d4e5f6a7-0000-0000-0000-000000000001 --all-fields
uip or users get d4e5f6a7-0000-0000-0000-000000000001 --output-filter 'Data.Email'

Forma de datos (--json de salida)

{
  "Code": "User",
  "Data": {
    "Key": "d4e5f6a7-0000-0000-0000-000000000001",
    "UserName": "[e-mail]",
    "FullName": "Admin User",
    "Email": "[e-mail]",
    "Type": "User",
    "IsActive": true
  }
}

Importación de uip o usuarios

Importa un director de directorio (un usuario, grupo, cuenta de robot o aplicación externa de Identity Service) en este tenant. Esta es la única forma en que esta CLI aprovisiona un nuevo usuario de tenant; no hay una herramienta independiente "crear un usuario" porque los usuarios de Orchestrator siempre están respaldados por un director de SI.

Hace referencia a un principal de IS existente por --username o --directory-id, más --type para declarar qué tipo de principal es (la CLI no adivina). Opcionalmente, asigna roles de carpeta en la misma llamada con --folder-path/--folder-key y --role-keys: tanto una carpeta como los roles deben proporcionarse juntos, o ninguno. Las importaciones --directory-id son idempotentes: importar un principal ya importado por ID de directorio devuelve el registro de tenant existente en lugar de fallar.

Las cuentas de robot y las aplicaciones externas deben importarse con --directory-id (el UUID de IS): Orchestrator no puede resolverlas <domain>\<name> de la forma en que resuelve un usuario de directorio. Busca el ID con uip admin robot-accounts list --search <name> o uip admin external-apps list.

Argumentos e identificadores necesarios

Nombre	Obligatorio	Propósito
--username	uno de --username/--directory-id	Nombre de usuario de Identity Service (normalmente un correo electrónico).
--directory-id	uno de --username/--directory-id	Identificador del directorio de Identity Service (asunto OIDC/UUID de IS). Obligatorio para los tipos DirectoryRobot y DirectoryExternalApplication .

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--type	DirectoryUser | DirectoryGroup | DirectoryRobot | DirectoryExternalApplication	obligatorio	Tipo principal de directorio.
—	--domain	text	—	Nombre de dominio del directorio configurado en Identity Service. Solo es necesario para entornos locales con dominios AD configurados.
—	--folder-path	Ruta	—	Carpeta a la que asignar el principal importado. Usar con --role-keys.
—	--folder-key	GUID	—	Carpeta alternativa a --folder-path. Usar con --role-keys.
—	--role-keys	CSV de GUID	—	GUID de rol de carpeta para conceder. Requiere una opción de carpeta; una opción de carpeta sin --role-keys también se rechaza.

Ejemplos

uip or users import --username [e-mail]

uip or users import --username [e-mail] \
    --folder-path Shared --role-keys a1b2c3d4-0000-0000-0000-000000000001

# Robot account — directory ID required
uip or users import --directory-id 11111111-2222-3333-4444-555555555555 \
    --type DirectoryRobot

Forma de datos (--json de salida)

{
  "Code": "UserImported",
  "Data": {
    "UserName": "[e-mail]",
    "Type": "DirectoryUser",
    "AssignedFolderPath": "Shared",
    "AssignedRoleKeys": ["a1b2c3d4-0000-0000-0000-000000000001"]
  }
}

AlreadyImported: true se añade cuando --directory-id coincide con un director ya presente en el tenant.

UIP o asignación de usuarios

Asigna un usuario a una carpeta, opcionalmente con roles en el nivel de carpeta.

Nota:

PRECAUCIÓN: destructivo en los roles. Si se pasa --role-keys , el servidor reemplaza todos los roles existentes del usuario en la carpeta de destino por los proporcionados: los roles que no están en la carga útil se eliminan de forma silenciosa. Para conservar los roles existentes, léelos primero con roles user-roles list <principal-name> --type <type> y pasa la unión completa deseada a --role-keys. Para la membresía de rol a nivel de tenant en un rol, utiliza roles users set en su lugar.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--user-key	GUID	obligatorio	Clave de usuario.
—	--role-keys	CSV de GUID	—	GUID de rol de ámbito de carpeta.
—	--folder-path	Ruta	—	Carpeta de destino. Proporciona esto o --folder-key.
—	--folder-key	GUID	—	Carpeta de destino.

Ejemplos

uip or users assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared"

uip or users assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared" \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002

uip or users assign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared" --output-filter 'Data.Status'

Forma de datos (--json de salida)

{
  "Code": "UserAssigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "Status": "Assigned successfully"
  }
}

uip o desasignación de usuarios

Eliminar un usuario de una carpeta. El usuario no se elimina, solo se elimina su asignación de carpeta.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--user-key	GUID	obligatorio	Clave de usuario.
—	--folder-path	Ruta	—	Carpeta de la que eliminar. Proporciona esto o --folder-key.
—	--folder-key	GUID	—	Carpeta de la que eliminar.

Ejemplos

uip or users unassign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared"

uip or users unassign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-key b1c2d3e4-0000-0000-0000-000000000001

uip or users unassign --user-key d4e5f6a7-0000-0000-0000-000000000001 \
    --folder-path "Shared" --output-filter 'Data.Status'

Forma de datos (--json de salida)

{
  "Code": "UserUnassigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "Status": "Unassigned successfully"
  }
}

actualización de uip o usuarios

Actualizar las propiedades del tenant de un usuario por clave (GUID). Lee los valores actuales, combina los campos proporcionados y guarda. Proporcione al menos una opción.

edit es un alias registrado para este verbo: uip or users edit funciona de forma idéntica a uip or users update.

Editable de forma fiable: perfil de licencia, marcadores de sesión y credenciales de robot desatendido. Los atributos de identidad (--name, --surname, --email, --type) son aceptados por la API, pero para los principales de directorio (DirectoryUser/Group/Robot/ExternalApplication) esos campos normalmente son sincronizados desde Identity Service: cambiarlos aquí solo edita la copia en caché del lado de Orchestrator y puede sobrescribirse en la siguiente sincronización IS. Para un cambio de identidad duradero, edita el principal de IS directamente.

Este comando no expone las asignaciones de roles: utiliza users assign (roles de carpeta) o users assign-roles (roles de tenant) para eso; la lista de roles de tenant actual siempre se reenvía sin cambios, por lo que una actualización nunca la afecta.

Argumentos

Nombre	Obligatorio	Propósito
<user-key>	Sí	Clave de usuario (GUID).

Opciones

Identidad (caché del lado de Orchestrator solo para directores de directorio)

Largo	Valor	Descripción
--name	text	Nuevo nombre.
--surname	text	Nuevo apellido.
--email	text	Nueva dirección de correo electrónico.
--type	text	Nuevo tipo de usuario (por ejemplo, User, DirectoryUser).

Permisos de licencia y sesión

Largo	Valor	Descripción
--license-type	text	Por ejemplo, Attended, Unattended, StudioPro.
--allow-unattended / --deny-unattended	Marca	Permitir o denegar la ejecución de trabajos unattended.
--allow-attended / --deny-attended	Marca	Permitir o denegar sesiones atendidas.
--allow-login / --deny-login	Marca	Permitir o denegar el inicio de sesión de Orchestrator.
--allow-personal-workspace / --deny-personal-workspace	Marca	Permitir o denegar el espacio de trabajo personal.
--active / --inactive	Marca	Activa o desactiva el usuario.

Credenciales de ejecución unattended

Largo	Valor	Descripción
--unattended-username	text	Cuenta de Windows para ejecución desatendida (por ejemplo, DOMAIN\user).
--unattended-password	text	Contraseña o, para un almacén de credenciales de solo lectura, el nombre de referencia del secreto externo.
--credential-store-key	GUID	Almacén de credenciales para credenciales de ejecución unattended. Usa credential-stores list para encontrarlo.
--credential-type	Default | SmartCard	Tipo de credencial.
--limit-concurrent / --no-limit-concurrent	Marca	Permitir o no permitir la ejecución simultánea en varias máquinas.

Si estableces cualquier marcador de credenciales unattended en un usuario sin registro UnattendedRobot existente, tanto --unattended-username como --unattended-password son necesarios a la vez: Orchestrator descarta silenciosamente un registro incompleto, por lo que CLI se niega a enviar uno en lugar de informar de un falso correcto. La edición de un registro existente acepta cualquier subconjunto de estos marcadores.

Ejemplos

uip or users update d4e5f6a7-0000-0000-0000-000000000001 --email [e-mail]

uip or users update d4e5f6a7-0000-0000-0000-000000000001 \
    --allow-unattended --license-type Unattended \
    --unattended-username DOMAIN\\bot --unattended-password s3cret

uip or users update d4e5f6a7-0000-0000-0000-000000000001 --inactive \
    --output-filter 'Data.Status'

Forma de datos (--json de salida)

{
  "Code": "UserUpdated",
  "Data": { "Key": "d4e5f6a7-0000-0000-0000-000000000001", "Status": "Updated successfully" }
}

uip o usuarios actuales

Devuelve el usuario actualmente autenticado. Útil para verificar la sesión y descubrir tu propia clave de usuario.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción

Ejemplos

uip or users current
uip or users current --output-filter 'Data.Key'
uip or users current --output table

Forma de datos (--json de salida)

La misma forma User que users get.

UIP o asignación de roles de usuarios

Asigna roles en el nivel de tenant a un usuario.

Nota:

PRECAUCIÓN: destructivo. El servidor reemplaza toda la lista de roles a nivel de tenant del usuario con las claves pasadas a través de --role-keys : los roles que no están en la carga útil se eliminan de forma silenciosa. Para conservar los roles de tenant existentes, léelos primero con roles user-roles list <principal-name> --type <type> y pasa la unión completa deseada a --role-keys. A diferencia de los users assign (roles a nivel de carpeta), esto establece roles que se aplican en todo el tenant.

Argumentos

Nombre	Obligatorio	Propósito
<user-key>	Sí	Clave de usuario (GUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--role-keys	CSV de GUID	obligatorio	GUID de rol para asignar en el ámbito del tenant.

Ejemplos

uip or users assign-roles d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001

uip or users assign-roles d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001,a1b2c3d4-0000-0000-0000-000000000002

uip or users assign-roles d4e5f6a7-0000-0000-0000-000000000001 \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.RolesAssigned'

Forma de datos (--json de salida)

{
  "Code": "UserRolesAssigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "RolesAssigned": 1,
    "Status": "Assigned successfully"
  }
}

Códigos de salida

Consulta Códigos de salida. Sin anulaciones específicas de verbos.

Comandos relacionados

• uip or roles : gestiona roles, membresía de rol-usuario e inspección de permisos principales (roles user-roles list, roles user-permissions list).
• uip or folders : busca claves de carpeta para users assign / unassign.
• uip or jobs , especialmente jobs start --user-keys.

Ver también

• Autenticación.
• Opciones globales.