uip o usuarios

uip or users los usuarios de Orchestrator en el nivel de tenant: enumera, crea, edita y elimina usuarios, además de asignarlos a carpetas y gestionar las asignaciones de roles en el nivel de tenant. Para la gestión de roles a nivel de carpeta, consulta uip or roles.

Sinopsis

uip or users <verb> [options]

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.
create	Crear un nuevo usuario; opcionalmente, asigna roles de tenant y establece credenciales de ejecución unattended.
delete	Eliminar un usuario por clave.
assign	Asigna un usuario a una carpeta, opcionalmente con roles en el nivel de carpeta.
unassign	Eliminar un usuario de una carpeta.
edit	Editar propiedades de 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.
—	--order-by	Campo	—	Ordenación de OData (por ejemplo, UserName asc).
—	--all-fields	Marca	Desactivado	Devuelve la carga útil de la API completa.

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, "HasMore": false }
}

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
-t	--tenant	name	sesión predeterminada	Anula el tenant.
—	--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.
—	--order-by	Campo	Id desc	Ordenación de OData.

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
-t	--tenant	name	sesión predeterminada	Anula el tenant.
—	--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
-t	--tenant	name	sesión predeterminada	Anula el tenant.
—	--all-fields	Marca	Desactivado	Devuelve la carga útil de la API completa.

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

uip o creación de usuarios

Crea un nuevo usuario de tenant. Solo se requiere --username . La API requiere rolesList, por lo que --role-keys se requiere efectivamente en la práctica: utilízalo con los GUID de rol de ámbito de tenant.

Opciones

Identidad

Corto	Largo	Valor	Predeterminado	Descripción
—	--username	text	obligatorio	Nombre de usuario de inicio de sesión.
—	--name	text	—	Nombre.
—	--surname	text	—	Apellido.
—	--email	text	—	'juan.pé[e-mail]'.
—	--type	ENUM	—	Tipo de usuario (por ejemplo, User, DirectoryUser).
-t	--tenant	name	sesión predeterminada	Anula el tenant.

Roles y licencia

Corto	Largo	Valor	Predeterminado	Descripción
—	--role-keys	CSV de GUID	—	GUID de roles de ámbito de tenant (resueltos en nombres de roles para la carga útil de la API).
—	--license-type	ENUM	—	Por ejemplo, Attended, Unattended, StudioPro.

Permisos de sesión (pares de marcadores)

Corto	Largo	Valor	Predeterminado	Descripción
—	--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

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

Ejemplos

uip or users create --username [e-mail] --email [e-mail] \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001

uip or users create --username [e-mail] --name Bot --surname Worker \
    --role-keys a1b2c3d4-0000-0000-0000-000000000002 \
    --unattended-username DOMAIN\\bot --unattended-password s3cret

uip or users create --username [e-mail] \
    --role-keys a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.Key'

Forma de datos (--json de salida)

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

uip o eliminación de usuarios

Eliminar de forma permanente un usuario del tenant.

Argumentos

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

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-t	--tenant	name	sesión predeterminada	Anula el tenant.

Ejemplos

uip or users delete d4e5f6a7-0000-0000-0000-000000000010
uip or users delete d4e5f6a7-0000-0000-0000-000000000010 --output-filter 'Data.Status'
uip or users delete d4e5f6a7-0000-0000-0000-000000000010 --output plain

Forma de datos (--json de salida)

{
  "Code": "UserDeleted",
  "Data": { "Key": "d4e5f6a7-0000-0000-0000-000000000010", "Status": "Deleted successfully" }
}

UIP o asignación de usuarios

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

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.
-t	--tenant	name	sesión predeterminada	Anula el tenant.

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.

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.
-t	--tenant	name	sesión predeterminada	Anula el tenant.

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

edición de uip o usuarios

Editar un usuario por clave. Lee los valores actuales, combina los campos proporcionados y guarda. Proporcione al menos una opción para actualizar.

Argumentos

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

Opciones

Los mismos marcadores que users create, excepto --username (no se puede cambiar) y --role-keys (usa users assign-roles en su lugar). Se aplican todos los pares de marcadores de permiso de sesión, tipo de licencia y opciones de credenciales unattended.

Ejemplos

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

uip or users edit d4e5f6a7-0000-0000-0000-000000000001 \
    --allow-unattended --license-type Unattended

uip or users edit 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
-t	--tenant	name	sesión predeterminada	Anula el tenant.

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. Esto reemplaza los roles de tenant actuales del usuario: utiliza roles set-role-users para la membresía adicional en un nivel de rol.

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.
-t	--tenant	name	sesión predeterminada	Anula el 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 : gestionar roles y membresía de rol-usuario.
• 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.