uip ou usuários

uip or users gerencia os usuários do Orchestrator no nível do tenant — listando, criando, editando e excluindo usuários, além de atribuí-los a pastas e gerenciar atribuições de funções no nível do tenant. Para gerenciamento de funções no nível da pasta, consulte uip or roles.

Resumo

uip or users <verb> [options]

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.
create	Criar um novo usuário; opcionalmente, atribua funções de tenant e defina credenciais de execução não assistida.
delete	Exclui um usuário por chave.
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.
edit	Edite propriedades do 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.
—	--order-by	Campo	—	Classificação OData (por exemplo, UserName asc).
—	--all-fields	Bandeira	desativada	Retorna a carga útil da API completa.

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

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
-t	--tenant	name	padrão da sessão	Substituir o tenant.
—	--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.
—	--order-by	Campo	Id desc	Classificação OData.

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
-t	--tenant	name	padrão da sessão	Substituir o tenant.
—	--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
-t	--tenant	name	padrão da sessão	Substituir o tenant.
—	--all-fields	Bandeira	desativada	Retorna a carga útil da API completa.

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 criação dos usuários

Crie um novo usuário de tenant. Apenas --username é necessário. A API requer rolesList, então --role-keys é efetivamente necessário na prática — use-o com GUIDs de função no escopo do tenant.

Opções

Identidade

Short	Long	Valor	Padrão	Description
—	--username	text	necessário	Nome de usuário de logon.
—	--name	text	—	Nome.
—	--surname	text	—	Sobrenome.
—	--email	text	—	endereço de e-mail.
—	--type	ENUM	—	Tipo de usuário (por exemplo, User, DirectoryUser).
-t	--tenant	name	padrão da sessão	Substituir o tenant.

Funções e licença

Short	Long	Valor	Padrão	Description
—	--role-keys	CSV de GUIDs	—	GUIDs de função no escopo do tenant (resolvidos como nomes de funções para a carga da API).
—	--license-type	ENUM	—	Por exemplo, Attended, Unattended, StudioPro.

Permissões de sessão (pares de sinalizador)

Short	Long	Valor	Padrão	Description
—	--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

Short	Long	Valor	Padrão	Description
—	--unattended-username	text	—	Conta do Windows (por exemplo, DOMAIN\user).
—	--unattended-password	text	—	Senha ou — para armazenamentos de credenciais somente leitura — o nome de referência do segredo externo.
—	--credential-store-key	GUID	—	Armazenamento de credenciais. credential-stores list para encontrá-lo.
—	--credential-type	ENUM	—	Default ou SmartCard.
—	--limit-concurrent / --no-limit-concurrent	Bandeira	—	Permita ou desabilita a execução simultânea em várias máquinas.

Exemplos

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'

Formato dos dados (--output json)

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

uip ou usuários excluem

Exclua permanentemente um usuário do tenant.

Argumentos

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

Opções

Short	Long	Valor	Padrão	Description
-t	--tenant	name	padrão da sessão	Substituir o tenant.

Exemplos

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

Formato dos dados (--output json)

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

uip ou os usuários atribuem

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

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.
-t	--tenant	name	padrão da sessão	Substituir o tenant.

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.

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.
-t	--tenant	name	padrão da sessão	Substituir o tenant.

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

edição dos usuários ou uip

Edite um usuário por chave. Lê os valores atuais, mescla os campos fornecidos e salva. Forneça pelo menos uma opção para atualizar.

Argumentos

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

Opções

Mesmos sinalizadores que users create, exceto --username (não podem ser alterados) e --role-keys (use users assign-roles em vez disso). Todos os pares de sinalizador de permissão de sessão, tipo de licença e opções de credencial unattended são aplicáveis.

Exemplos

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'

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
-t	--tenant	name	padrão da sessão	Substituir o tenant.

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. Isso substitui as funções de tenant atuais do usuário — use roles set-role-users para associação cumulativa em um nível de função.

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.
-t	--tenant	name	padrão da sessão	Substituir o 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 e associação de usuário de função.
• 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.