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 gerencia usuários do Orchestrator no nível do tenant. Os usuários do Orchestrator são apoiados pelo Identity Service (IS) — essa ferramenta não cria usuários independentes do zero. Em vez disso, users import faz referência a um principal de diretório IS existente (um usuário, grupo, conta de robô ou aplicativo externo) e provisiona-o para o tenant; users update em seguida, edita as propriedades do lado do tenant (licença, permissões de sessão, credenciais unattended) que estão no lado do Orchestrator. Não há users delete — a remoção do usuário é gerenciada por meio do serviço de identidade ou do portal do Orchestrator, não dessa CLI. Para gerenciamento de funções no nível da pasta, consulte 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	Importe um principal de diretório de serviço de identidade existente para o 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)	Atualizar as propriedades do lado do tenant de um usuário (semântica PATCH).
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 ou importação de usuários

Importe uma entidade de diretório — um usuário, grupo, conta de robô ou aplicativo externo do Serviço de Identidade — para este tenant. Essa é a única maneira que essa CLI provisiona um novo usuário do tenant; não existe uma atividade independente “criar um usuário” verbo, porque os usuários do Orchestrator são sempre apoiados por um IS principal.

Referencia um principal IS existente por --username ou --directory-id, mais --type para declarar qual tipo de principal é (a CLI não supõe). Opcionalmente, atribui funções de pasta na mesma chamada com --folder-path/--folder-key e --role-keys — uma pasta e as funções devem ser fornecidas juntas. --directory-id As importações são idempotent: a importação de um principal já importado por ID de diretório retorna o registro do tenant existente em vez de falhar.

Contas de robô e aplicativos externos devem ser importados com --directory-id (o UUID IS) — o Orchestrator não pode resolvê-las por <domain>\<name> da forma como resolve um usuário de diretório. Encontre o ID com uip admin robot-accounts list --search <name> ou uip admin external-apps list.

Argumentos e identificadores obrigatórios

Name	Required	Finalidade
--username	um de --username/--directory-id	Nome de usuário do serviço de identidade (normalmente um e-mail).
--directory-id	um de --username/--directory-id	Identificador do diretório do serviço de identidade (assunto do OIDC / UUID do IS). Necessário para os tipos DirectoryRobot e DirectoryExternalApplication .

Opções

Short	Long	Valor	Padrão	Description
—	--type	DirectoryUser | DirectoryGroup | DirectoryRobot | DirectoryExternalApplication	necessário	Tipo principal do diretório.
—	--domain	text	—	Nome de domínio do diretório conforme configurado no Identity Service. Necessário apenas para ambientes locais com domínios AD configurados.
—	--folder-path	Path	—	Pasta à qual atribuir o principal importado. Use --role-keys com.
—	--folder-key	GUID	—	Pasta alternativa a --folder-path. Use com --role-keys.
—	--role-keys	CSV de GUIDs	—	GUIDs de função de pasta a serem concedidos. Requer uma opção de pasta; uma opção de pasta sem --role-keys também é rejeitada.

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 é adicionado quando --directory-id corresponde a um principal já presente no 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:

CUIDADO — destrutivo em funções. Se --role-keys for passado, o servidor substituirá todas as funções existentes do usuário na pasta de destino pelas fornecidas — as funções que não estão na carga são removidas silenciosamente. Para preservar as funções existentes, leia-as primeiro com roles user-roles list <principal-name> --type <type> e passe a união completa desejada para --role-keys. Para associação cumulativa de função no nível do tenant em uma função, use roles users set em vez disso.

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 um usuário de uma pasta. O usuário não é excluído — apenas sua atribuição de pasta é removida.

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

Atualização dos usuários ou uip

Atualize as propriedades no lado do tenant de um usuário por chave (GUID). Lê os valores atuais, mescla os campos fornecidos e salva. Forneça pelo menos uma opção.

edit é um alias registrado para esse verbo — uip or users edit funciona de forma idêntica a uip or users update.

Editável de forma confiável: perfil de licença, sinalizadores de sessão e credenciais de robô não assistido. Os atributos de identidade (--name, --surname, --email, --type) são aceitos pela API, mas para os principais de diretório (DirectoryUser/Group/Robot/ExternalApplication) esses campos normalmente são sincronizados a partir do Identity Service — alterá-los aqui apenas edita a cópia em cache do lado do Orchestrator e pode ser substituído na próxima sincronização do IS. Para uma alteração de identidade estável, edite o principal IS diretamente.

Esse comando não expõe atribuições de função — use users assign (funções de pasta) ou users assign-roles (funções de tenant) para isso; a lista de funções do tenant atual é sempre reenviada inalterada para que uma atualização nunca a afeta.

Argumentos

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

Opções

Identity (cache do lado do Orchestrator apenas para principais de diretório)

Long	Valor	Description
--name	text	Novo nome.
--surname	text	Novo sobrenome.
--email	text	Novo endereço de email.
--type	text	Novo tipo de usuário (por exemplo, User, DirectoryUser).

Permissões de licença e sessão

Long	Valor	Description
--license-type	text	Por exemplo, 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	Conta do Windows para execução unattended (por exemplo, DOMAIN\user).
--unattended-password	text	Senha ou — para um armazenamento de credenciais somente leitura — o nome de referência do segredo externo.
--credential-store-key	GUID	Armazenamento do Credential para credenciais de execução unattended. Use credential-stores list para encontrá-lo.
--credential-type	Default | SmartCard	Tipo de credencial.
--limit-concurrent / --no-limit-concurrent	Bandeira	Permita ou desabilita a execução simultânea em várias máquinas.

Se você definir qualquer sinalizador de credencial não assistido em um usuário sem registro UnattendedRobot existente, --unattended-username e --unattended-password são necessários juntos — o Orchestrator descarta silenciosamente um registro incompleto, de modo que a CLI se recusa a enviar um em vez de relatar um falso sucesso. A edição de um registro existente aceita qualquer subconjunto desses sinalizadores.

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

Atribuir funções no nível do tenant a um usuário.

Observação:

CUIDADO — destrutivo. O servidor substitui toda a lista de funções no nível do tenant do usuário pelas chaves passadas por meio de --role-keys — as funções que não estão na carga são removidas silenciosamente. Para preservar as funções de tenant existentes, leia-as primeiro com roles user-roles list <principal-name> --type <type> e passe a união completa desejada para --role-keys. Ao contrário de users assign (funções no nível da pasta), isso define funções que se aplicam a todo o 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 — gerenciar funções, associação de usuário de função e inspeção de permissão principal (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.