usuários administradores da uip

Sintaxe e opções para "usuários uip admin" e "grupos de administrador uip", que gerenciam usuários, grupos e associação a grupos do diretório do Identity Server.

uip admin users e uip admin groups gerenciam usuários e grupos locais do Identity Server dentro da partição da sua organização — as identidades no nível do diretório por trás do login, não atribuições de funções no nível do Orchestrator. Dois grupos de comando independentes residem aqui: users (criação/leitura/atualização/exclusão/invite usuários do diretório) e groups (criação/leitura/atualização/exclusão de grupos, além de gerenciamento de associação).

é aceita na --organization dos verbos em ambos os grupos, mas está obsoleta e ignorada — a organização é sempre derivada do contexto de login atual. Passá-lo imprime um aviso (--organization is deprecated and ignored; organization is derived from login context), mas não tem efeito.

Resumo

uip admin users list [--search <term>] [--sort-by <field>] [--sort-order asc|desc] [--limit <n>] [--offset <n>]
uip admin users get <user-id>
uip admin users create <username> --email <email> [--name <name>] [--surname <surname>]
uip admin users update <user-id> [--email <email>] [--name <name>] [--surname <surname>]
uip admin users delete <user-id>
uip admin users invite --email <emails> [--name <name>] [--surname <surname>]

uip admin groups list
uip admin groups get <group-id>
uip admin groups create <name>
uip admin groups update <group-id> --name <name>
uip admin groups delete <group-id>
uip admin groups members list <group-id> [--limit <n>] [--offset <n>]
uip admin groups members add <group-id> --user-ids <ids>
uip admin groups members revoke <group-id> --user-ids <ids>

Verbo

Grupo	Texto	Finalidade
users	list	Liste os usuários na partição (pesquisável, classificável, paginado).
users	get	Obtenha os detalhes completos de um usuário por ID.
users	create	Crie um novo usuário local.
users	update	Atualizar o email, nome ou sobrenome de um usuário.
users	delete	Exclua um usuário por ID.
users	invite	Convide um ou mais usuários por e-mail.
groups	list	Liste todos os grupos na partição.
groups	get	Obtenha os detalhes de um grupo por ID.
groups	create	Criar um novo grupo local.
groups	update	Renomear um grupo.
groups	delete	Exclua um grupo por ID.
groups members	list	Lista os membros de um grupo.
groups members	add	Adicione um ou mais usuários a um grupo.
groups members	revoke	Remova um ou mais usuários de um grupo.

lista de usuários administradores do uip

Liste os usuários na partição. Retorna o ID do usuário, nome de usuário, email, nome e hora de criação.

Opções

Long	Short	Valor	Padrão	Description
--search <term>	-s	String	—	Pesquise usuários por nome ou e-mail.
--sort-by <field>		String	—	Classificar campo, por exemplo UserName, Email.
--sort-order <direction>		asc|desc	asc	Classificar direção.
--limit <number>	-l	Número inteiro	50 (DEFAULT_PAGE_SIZE)	Número de itens a serem retornados.
--offset <number>		Número inteiro	0	Número de itens a serem ignorados.
--login-validity <minutes>		Número inteiro	—	Substitui a validade do token para esta chamada.

Exemplo

uip admin users list --limit 5

Formato dos dados (--output json)

{
  "Code": "UserList",
  "Data": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "userName": "[e-mail]",
      "email": "[e-mail]",
      "name": "Admin",
      "surname": "User",
      "displayName": "Admin User",
      "creationTime": "2026-01-15T10:00:00.000Z"
    }
  ]
}

usuários administradores do uip obter

Obtenha detalhes do usuário por ID.

Argumentos

Name	Required	Finalidade
<user-id>	sim	ID do usuário (UUID). Encontre-o com users list.

Exemplo

uip admin users get a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)

{
  "Code": "UserDetails",
  "Data": {
    "id": "a1b2c3d4-0000-0000-0000-000000000001",
    "userName": "[e-mail]",
    "email": "[e-mail]",
    "name": "Admin",
    "surname": "User",
    "displayName": "Admin User",
    "creationTime": "2026-01-15T10:00:00.000Z"
  }
}

usuários administradores da uip criar

Crie um novo usuário local.

Argumentos

Name	Required	Finalidade
<username>	sim	Nome de usuário do novo usuário.

Opções

Long	Short	Valor	Required	Description
--email <email>	-e	email	sim	endereço de e-mail.
--name <name>	-n	String	não	Nome.
--surname <surname>		String	não	Sobrenome.

Exemplo

uip admin users create newuser --email "[e-mail]" --name "John" --surname "Doe"

Formato dos dados (--output json)

{ "Code": "UserCreated", "Data": { "Succeeded": true } }

atualização dos usuários administradores do uip

Atualizar o email, nome ou sobrenome de um usuário existente. Pelo menos um campo é necessário — a chamada sem falha do lado do cliente ("No fields to update") antes de qualquer chamada de rede.

Argumentos

Name	Required	Finalidade
<user-id>	sim	ID do usuário (UUID).

Opções

Long	Short	Valor	Description
--email <email>	-e	email	Novo endereço de email.
--name <name>	-n	String	Novo nome.
--surname <surname>		String	Novo sobrenome.

Exemplo

uip admin users update a1b2c3d4-0000-0000-0000-000000000001 --name "Jane" --surname "Doe" --email "[e-mail]"

Formato dos dados (--output json)

{ "Code": "UserUpdated" }

usuários administradores do uip exclusão

Exclua um usuário por ID.

Argumentos

Name	Required	Finalidade
<user-id>	sim	ID do usuário (UUID).

Exemplo

uip admin users delete a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)

{ "Code": "UserDeleted", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Status": "Deleted successfully" } }

usuários administradores da uip convite

Convide um ou mais usuários por e-mail. Envia um convite para ingressar na organização.

Opções

Long	Short	Valor	Required	Description
--email <emails>	-e	separados por vírgula	sim	Um ou mais endereços de email a serem convidados.
--name <name>	-n	String	não	Nome aplicado a cada usuário convidado.
--surname <surname>		String	não	Sobrenome aplicado a cada usuário convidado.

Exemplo

uip admin users invite --email "[e-mail]"

Formato dos dados (--output json)

{ "Code": "UsersInvited", "Data": { "succeeded": true } }

lista de grupos de administrador do uip

Liste todos os grupos na partição. Retorna o ID do grupo, nome, tipo e hora de criação. Sem opções de filtragem/paginação — retorna tudo em uma chamada.

Exemplo

uip admin groups list

Formato dos dados (--output json)

{
  "Code": "GroupList",
  "Data": [
    { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Administrators", "displayName": "Administrators", "type": "BuiltIn", "creationTime": "2026-01-15T10:00:00.000Z" }
  ]
}

grupos de administradores uip Obter

Obtenha detalhes do grupo por ID.

Argumentos

Name	Required	Finalidade
<group-id>	sim	ID do grupo (UUID). Encontre-o com groups list.

Exemplo

uip admin groups get a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)

{ "Code": "GroupDetails", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Administrators", "displayName": "Administrators", "type": "BuiltIn", "creationTime": "2026-01-15T10:00:00.000Z" } }

grupos de administradores uip criar

Criar um novo grupo local.

Argumentos

Name	Required	Finalidade
<name>	sim	Nome do grupo.

Exemplo

uip admin groups create "DevOps Team"

Formato dos dados (--output json)

{ "Code": "GroupCreated", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000002", "name": "DevOps Team", "displayName": "DevOps Team", "type": "Custom" } }

O comando gera um UUID do lado do cliente para a id do grupo antes de chamar a API — o servidor rejeita a criação de grupos com um 409 se nenhuma ID for fornecida.

atualização de grupos de administradores uip

Renomear um grupo. --name é o único campo atualizável e é obrigatório — omitir isso falha no lado do cliente ("No fields to update").

Argumentos

Name	Required	Finalidade
<group-id>	sim	ID do grupo (UUID).

Opções

Long	Short	Valor	Required	Description
--name <name>	-n	String	sim	Novo nome do grupo.

Exemplo

uip admin groups update a1b2c3d4-0000-0000-0000-000000000001 --name "Renamed Group"

Formato dos dados (--output json)

{ "Code": "GroupUpdated" }

exclusão de grupos de administradores do uip

Exclua um grupo por ID.

Argumentos

Name	Required	Finalidade
<group-id>	sim	ID do grupo (UUID).

Exemplo

uip admin groups delete a1b2c3d4-0000-0000-0000-000000000002

Formato dos dados (--output json)

{ "Code": "GroupDeleted", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000002", "Status": "Deleted successfully" } }

lista de membros dos grupos de administradores uip

Lista os membros de um grupo.

Argumentos

Name	Required	Finalidade
<group-id>	sim	ID do grupo (UUID).

Opções

Long	Short	Valor	Padrão	Description
--limit <number>	-l	Número inteiro	50	Número de itens a serem retornados.
--offset <number>		Número inteiro	0	Número de itens a serem ignorados.

Exemplo

uip admin groups members list a1b2c3d4-0000-0000-0000-000000000001

Formato dos dados (--output json)

{ "Code": "GroupMembers", "Data": [] }

administradores grupos de membros da uip adicionar

Adicione um ou mais usuários a um grupo.

Observação:

Implementado como uma leitura-modificação-escrita: o comando busca o nome atual do grupo e, em seguida, chama a API de atualização de grupo com directoryUserIDsToAdd — a mesma operação subjacente que groups update, apenas com um campo de carga diferente. Não há nenhum recurso “adicionar membro” dedicado. Chamada de API.

Argumentos

Name	Required	Finalidade
<group-id>	sim	ID do grupo (UUID).

Opções

Long	Valor	Required	Description
--user-ids <ids>	separados por vírgula	sim	IDs de usuário a adicionar. Encontre-os com users list.

Exemplo

uip admin groups members add a1b2c3d4-0000-0000-0000-000000000001 --user-ids "user-id-1,user-id-2"

Formato dos dados (--output json)

{ "Code": "GroupMembersAdded" }

grupos de administradores uip revogação de membros

Remova um ou mais usuários de um grupo. Mesmo mecanismo de leitura-modificação-gravação que members add, usando directoryUserIDsToRemove.

Argumentos

Name	Required	Finalidade
<group-id>	sim	ID do grupo (UUID).

Opções

Long	Valor	Required	Description
--user-ids <ids>	separados por vírgula	sim	IDs de usuário a serem removidos. Devem ser membros atuais.

Exemplo

uip admin groups members revoke a1b2c3d4-0000-0000-0000-000000000001 --user-ids "user-id-1"

Formato dos dados (--output json)

{ "Code": "GroupMembersRevoked" }

Relacionado

• uip admin robot-accounts — identidades não humanas, tokens de acesso pessoal e referência de escopo do OAuth.
• uip admin external-apps — registros de clientes OAuth2 e credenciais federadas.
• uip admin smtp — configuração de e-mail da organização.
• uip platform users — alocação de licenças (uma superfície de usuário diferente, focada em licenças).

Veja também

• Opções globais
• Códigos de saída