uip admin users

Syntax and options for `uip admin users` and `uip admin groups`, which manage Identity Server directory users, groups, and group membership.

uip admin users and uip admin groups manage local Identity Server users and groups within your organization's partition — the directory-level identities behind login, not Orchestrator-level role assignments. Two independent command groups live here: users (create/read/update/delete/invite directory users) and groups (create/read/update/delete groups, plus membership management).

--organization is accepted on most verbs in both groups but is deprecated and ignored — the organization is always derived from your current login context. Passing it prints a warning (--organization is deprecated and ignored; organization is derived from login context) but has no effect.

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	List users in the partition (searchable, sortable, paginated).
users	get	Get a user's full details by ID.
users	create	Create a new local user.
users	update	Update a user's email, first name, or last name.
users	delete	Exclua um usuário por ID.
users	invite	Invite one or more users by email.
groups	list	List all groups in the partition.
groups	get	Get a group's details by ID.
groups	create	Create a new local group.
groups	update	Rename a group.
groups	delete	Delete a group by ID.
groups members	list	List a group's members.
groups members	add	Add one or more users to a group.
groups members	revoke	Remove one or more users from a group.

uip admin users list

List users in the partition. Returns user ID, username, email, name, and creation time.

Opções

Long	Short	Valor	Padrão	Description
--search <term>	-s	String	—	Search users by name or email.
--sort-by <field>		String	—	Sort field, e.g. UserName, Email.
--sort-order <direction>		asc|desc	asc	Sort direction.
--limit <number>	-l	Número inteiro	50 (DEFAULT_PAGE_SIZE)	Number of items to return.
--offset <number>		Número inteiro	0	Number of items to skip.
--login-validity <minutes>		Número inteiro	—	Override token validity for this call.

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

uip admin users get

Get user details by ID.

Argumentos

Name	Required	Finalidade
<user-id>	sim	User ID (UUID). Find it with 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"
  }
}

uip admin users create

Create a new local user.

Argumentos

Name	Required	Finalidade
<username>	sim	Username for the new user.

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

uip admin users update

Update an existing user's email, first name, or last name. At least one field is required — calling with none fails client-side ("No fields to update") before any network call.

Argumentos

Name	Required	Finalidade
<user-id>	sim	User ID (UUID).

Opções

Long	Short	Valor	Description
--email <email>	-e	email	New email address.
--name <name>	-n	String	New first name.
--surname <surname>		String	New last name.

Exemplo

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

Formato dos dados (--output json)

{ "Code": "UserUpdated" }

uip admin users delete

Exclua um usuário por ID.

Argumentos

Name	Required	Finalidade
<user-id>	sim	User ID (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" } }

uip admin users invite

Invite one or more users by email. Sends an invitation to join the organization.

Opções

Long	Short	Valor	Required	Description
--email <emails>	-e	comma-separated	sim	One or more email addresses to invite.
--name <name>	-n	String	não	First name applied to every invited user.
--surname <surname>		String	não	Last name applied to every invited user.

Exemplo

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

Formato dos dados (--output json)

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

uip admin groups list

List all groups in the partition. Returns group ID, name, type, and creation time. No filtering/pagination options — returns everything in one call.

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

uip admin groups get

Get group details by ID.

Argumentos

Name	Required	Finalidade
<group-id>	sim	Group ID (UUID). Find it with 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" } }

uip admin groups create

Create a new local group.

Argumentos

Name	Required	Finalidade
<name>	sim	Group name.

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

The command generates a client-side UUID for the group's id before calling the API — the server rejects group creation with a 409 if no ID is supplied.

uip admin groups update

Rename a group. --name is the only updatable field and is required — omitting it fails client-side ("No fields to update").

Argumentos

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

Opções

Long	Short	Valor	Required	Description
--name <name>	-n	String	sim	New group name.

Exemplo

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

Formato dos dados (--output json)

{ "Code": "GroupUpdated" }

uip admin groups delete

Delete a group by ID.

Argumentos

Name	Required	Finalidade
<group-id>	sim	Group ID (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" } }

uip admin groups members list

List a group's members.

Argumentos

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

Opções

Long	Short	Valor	Padrão	Description
--limit <number>	-l	Número inteiro	50	Number of items to return.
--offset <number>		Número inteiro	0	Number of items to skip.

Exemplo

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

Formato dos dados (--output json)

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

uip admin groups members add

Add one or more users to a group.

Observação:

Implemented as a read-modify-write: the command fetches the group's current name, then calls the group-update API with directoryUserIDsToAdd — the same underlying operation as groups update, just with a different payload field. There is no dedicated "add member" API call.

Argumentos

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

Opções

Long	Valor	Required	Description
--user-ids <ids>	comma-separated	sim	User IDs to add. Find them with 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" }

uip admin groups members revoke

Remove one or more users from a group. Same read-modify-write mechanism as members add, using directoryUserIDsToRemove.

Argumentos

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

Opções

Long	Valor	Required	Description
--user-ids <ids>	comma-separated	sim	User IDs to remove. Must be current members.

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 — non-human identities, personal access tokens, and OAuth scope reference.
• uip admin external-apps — OAuth2 client registrations and federated credentials.
• uip admin smtp — organization email configuration.
• uip platform users — license allocation (a different, license-focused user surface).

Veja também

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