uip ou usuários

Sintaxe e opções para "uip or user", que gerencia os usuários do tenant do Orchestrator e suas atribuições de pasta e função.

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.

Resumo

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>

Verbo

Texto	Finalidade
list	Lista os usuários do tenant com filtros opcionais.
list-in-folder	Lista os usuários atribuídos a uma pasta, com suas funções no nível da pasta.
list-available	Lista os usuários que ainda podem ser atribuídos a uma pasta (ainda não atribuída).
get	Busca um usuário por chave.
import	Import an existing Identity Service directory principal into the tenant.
assign	Atribua um usuário a uma pasta, opcionalmente com funções no nível da pasta.
unassign	Remove um usuário de uma pasta.
update (alias edit)	Update a user's tenant-side properties (PATCH semantics).
current	Retorne detalhes do usuário atualmente autenticado.
assign-roles	Substitui as atribuições de função no nível do tenant de um usuário.

uip ou lista de usuários

Liste usuários no tenant. Retorna a chave do usuário (GUID), nome de usuário, nome completo, email, tipo e status ativo.

Opções

Short	Long	Valor	Padrão	Description
—	--key	GUID	—	Filtra por chave de usuário (correspondência exata).
—	--username	text	—	Filtrar por nome de usuário (contém correspondência).
—	--email	text	—	Filtra por endereço de email (contém correspondência).
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.
—	--sort-by	Campo	—	Classificação OData (por exemplo, UserName asc).
—	--all-fields	Bandeira	desativada	Retorna a carga útil da API completa em vez do resumo selecionado.

Exemplos

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

Formato dos dados (--output json)

{
  "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 ou list-in-folder de usuários

Lista os usuários atribuídos a uma pasta, com suas funções no nível da pasta. Requer --folder-path ou --folder-key.

Opções

Short	Long	Valor	Padrão	Description
—	--folder-path	Path	—	Pasta de destino. Forneça esta ou --folder-key.
—	--folder-key	GUID	—	Pasta de destino. Forneça esta ou --folder-path.
—	--include-inherited	Bandeira	desativada	Mostre também usuários herdados de pastas pai.
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.
—	--sort-by	Campo	Id desc	Classificação OData.
—	--all-fields	Bandeira	desativada	Retorna a carga útil da API completa em vez do resumo selecionado.

Exemplos

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

Formato dos dados (--output json)

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

uip ou lista de usuários disponíveis

Liste os usuários do tenant que ainda podem ser atribuídos a uma pasta. Use as chaves retornadas com users assign ou roles assign.

Opções

Short	Long	Valor	Padrão	Description
—	--folder-path	Path	—	Pasta de destino. Forneça esta ou --folder-key.
—	--folder-key	GUID	—	Pasta de destino. Forneça esta ou --folder-path.
-s	--search	text	—	Filtrar por nome de usuário (contém correspondência).
-l	--limit	Número	50	Tamanho da página
—	--offset	Número	0	Ignorar contagem.

Exemplos

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'

Formato dos dados (--output json)

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

o uip ou os usuários recebem

Buscar um usuário por chave GUID.

Argumentos

Name	Required	Finalidade
<user-key>	sim	Chave de usuário (GUID).

Opções

Short	Long	Valor	Padrão	Description
—	--all-fields	Bandeira	desativada	Retorna a carga útil da API completa em vez do resumo selecionado.

Exemplos

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'

Formato dos dados (--output json)

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

Name	Required	Finalidade
--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.

Opções

Short	Long	Valor	Padrão	Description
—	--type	DirectoryUser | DirectoryGroup | DirectoryRobot | DirectoryExternalApplication	necessário	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	Path	—	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 GUIDs	—	Folder role GUIDs to grant. Requires a folder option; a folder option without --role-keys is also rejected.

Exemplos

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

Formato dos dados (--output json)

{
  "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 ou os usuários atribuem

Atribua um usuário a uma pasta, opcionalmente com funções no nível da pasta.

Observação:

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.

Opções

Short	Long	Valor	Padrão	Description
—	--user-key	GUID	necessário	Chave do usuário.
—	--role-keys	CSV de GUIDs	—	GUIDs de função com escopo de pasta.
—	--folder-path	Path	—	Pasta de destino. Forneça esta ou --folder-key.
—	--folder-key	GUID	—	Pasta de destino.

Exemplos

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'

Formato dos dados (--output json)

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

uip ou usuários cancelar atribuição

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

Opções

Short	Long	Valor	Padrão	Description
—	--user-key	GUID	necessário	Chave do usuário.
—	--folder-path	Path	—	Pasta da qual remover. Forneça esta ou --folder-key.
—	--folder-key	GUID	—	Pasta da qual remover.

Exemplos

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'

Formato dos dados (--output json)

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

Name	Required	Finalidade
<user-key>	sim	Chave de usuário (GUID).

Opções

Identity (Orchestrator-side cache only for directory principals)

Long	Valor	Description
--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

Long	Valor	Description
--license-type	text	For example Attended, Unattended, StudioPro.
--allow-unattended / --deny-unattended	Bandeira	Permitir ou negar a execução de trabalhos unattended.
--allow-attended / --deny-attended	Bandeira	Permitir ou negar sessões assistidas.
--allow-login / --deny-login	Bandeira	Permita ou recuse o logon do Orchestrator.
--allow-personal-workspace / --deny-personal-workspace	Bandeira	Permitir ou negar o espaço de trabalho pessoal.
--active / --inactive	Bandeira	Ative ou desative o usuário.

Credenciais de execução não assistida

Long	Valor	Description
--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	Bandeira	Permita ou desabilita a execução simultânea em várias 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.

Exemplos

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'

Formato dos dados (--output json)

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

uip ou usuários atuais

Retorne o usuário atualmente autenticado. Útil para verificar a sessão e descobrir sua própria chave de usuário.

Opções

Short	Long	Valor	Padrão	Description

Exemplos

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

Formato dos dados (--output json)

Mesma forma User que users get.

uip ou usuários atribuir-funções

Assign tenant-level roles to a user.

Observação:

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

Name	Required	Finalidade
<user-key>	sim	Chave de usuário (GUID).

Opções

Short	Long	Valor	Padrão	Description
—	--role-keys	CSV de GUIDs	necessário	GUIDs de função a serem atribuídos no escopo do tenant.

Exemplos

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'

Formato dos dados (--output json)

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

Códigos de saída

Consulte Códigos de saída. Nenhuma substituição específica do verbo.

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 — localize chaves de pasta para users assign / unassign.
• uip or jobs — especialmente jobs start --user-keys.

Veja também

• Autenticação.
• Opções globais.