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 manages Orchestrator users at the tenant level. Orchestrator users are backed by Identity Service (IS) — this tool does not create standalone users from scratch. Instead, users import references an existing IS directory principal (a user, group, robot account, or external application) and provisions it into the tenant; users update then edits the tenant-side properties (license, session permissions, unattended credentials) that live on the Orchestrator side. There is no users delete — user removal is managed through Identity Service or the Orchestrator portal, not this CLI. For folder-level role management, see 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	Import an existing Identity Service directory principal into the 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)	Update a user's tenant-side properties (PATCH semantics).
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
  }
}

uip or users import

Import a directory principal — an Identity Service user, group, robot account, or external application — into this tenant. This is the only way this CLI provisions a new tenant user; there is no standalone "create a user" verb, because Orchestrator users are always backed by an IS principal.

References an existing IS principal by --username or --directory-id, plus --type to declare which kind of principal it is (the CLI does not guess). Optionally assigns folder roles in the same call with --folder-path/--folder-key and --role-keys — both a folder and roles must be provided together, or neither. --directory-id imports are idempotent: importing an already-imported principal by directory ID returns the existing tenant record instead of failing.

Robot accounts and external applications must be imported with --directory-id (the IS UUID) — Orchestrator can't resolve them by <domain>\<name> the way it resolves a directory user. Find the ID with uip admin robot-accounts list --search <name> or uip admin external-apps list.

Arguments and required identifiers

Nombre	Obligatorio	Propósito
--username	one of --username/--directory-id	Identity Service username (typically an email).
--directory-id	one of --username/--directory-id	Identity Service directory identifier (OIDC subject / IS UUID). Required for DirectoryRobot and DirectoryExternalApplication types.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--type	DirectoryUser | DirectoryGroup | DirectoryRobot | DirectoryExternalApplication	obligatorio	Directory principal type.
—	--domain	text	—	Directory domain name as configured in Identity Service. Only needed for on-premises environments with configured AD domains.
—	--folder-path	Ruta	—	Folder to assign the imported principal to. Use with --role-keys.
—	--folder-key	GUID	—	Folder alternative to --folder-path. Use with --role-keys.
—	--role-keys	CSV de GUID	—	Folder role GUIDs to grant. Requires a folder option; a folder option without --role-keys is also rejected.

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 is added when --directory-id matched a principal already present in the tenant.

UIP o asignación de usuarios

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

Nota:

CAUTION — destructive on roles. If --role-keys is passed, the server replaces all of the user's existing roles in the target folder with the ones supplied — roles not in the payload are removed silently. To preserve existing roles, read them first with roles user-roles list <principal-name> --type <type> and pass the full desired union to --role-keys. For additive tenant-level role membership on a role, use roles users set instead.

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

Remove a user from a folder. The user is not deleted — only their folder assignment is removed.

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

uip or users update

Update a user's tenant-side properties by key (GUID). Reads current values, merges the supplied fields, and saves. Provide at least one option.

edit is a registered alias for this verb — uip or users edit works identically to uip or users update.

Reliably editable: license profile, session flags, and unattended robot credentials. Identity attributes (--name, --surname, --email, --type) are accepted by the API, but for directory principals (DirectoryUser/Group/Robot/ExternalApplication) those fields are normally synced from Identity Service — changing them here only edits the Orchestrator-side cached copy and may be overwritten on the next IS sync. For a durable identity change, edit the IS principal directly.

This command does not expose role assignments — use users assign (folder roles) or users assign-roles (tenant roles) for that; the current tenant role list is always re-sent unchanged so an update never touches it.

Argumentos

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

Opciones

Identity (Orchestrator-side cache only for directory principals)

Largo	Valor	Descripción
--name	text	New first name.
--surname	text	New last name.
--email	text	New email address.
--type	text	New user type (for example User, DirectoryUser).

License and session permissions

Largo	Valor	Descripción
--license-type	text	For example 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	Windows account for unattended execution (for example DOMAIN\user).
--unattended-password	text	Password, or — for a read-only credential store — the external secret reference name.
--credential-store-key	GUID	Credential store for unattended execution credentials. Use credential-stores list to find it.
--credential-type	Default | SmartCard	Credential type.
--limit-concurrent / --no-limit-concurrent	Marca	Permitir o no permitir la ejecución simultánea en varias máquinas.

If you set any unattended-credential flag on a user with no existing UnattendedRobot record, both --unattended-username and --unattended-password are required together — Orchestrator silently discards an incomplete record, so the CLI refuses to submit one rather than report a false success. Editing an existing record accepts any subset of these flags.

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

Assign tenant-level roles to a user.

Nota:

CAUTION — destructive. The server replaces the user's entire tenant-level role list with the keys passed via --role-keys — roles not in the payload are removed silently. To preserve existing tenant roles, read them first with roles user-roles list <principal-name> --type <type> and pass the full desired union to --role-keys. Unlike users assign (folder-level roles), this sets roles that apply across the entire 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 — manage roles, role-user membership, and principal permission inspection (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.