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.

大纲

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>

动词

组	动词	用途
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	按 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.

选项

长	短	值	默认	描述
--search <term>	-s	字符串	—	Search users by name or email.
--sort-by <field>		字符串	—	Sort field, e.g. UserName, Email.
--sort-order <direction>		asc|desc	asc	Sort direction.
--limit <number>	-l	整数	50 (DEFAULT_PAGE_SIZE)	Number of items to return.
--offset <number>		整数	0	Number of items to skip.
--login-validity <minutes>		整数	—	Override token validity for this call.

示例

uip admin users list --limit 5

数据形状（--输出 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.

参数

名称	必填	用途
<user-id>	是	User ID (UUID). Find it with users list.

示例

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

数据形状（--输出 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.

参数

名称	必填	用途
<username>	是	Username for the new user.

选项

长	短	值	必填	描述
--email <email>	-e	电子邮件	是	电子邮件地址。
--name <name>	-n	字符串	否	名字。
--surname <surname>		字符串	否	姓氏。

示例

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

数据形状（--输出 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.

参数

名称	必填	用途
<user-id>	是	User ID (UUID).

选项

长	短	值	描述
--email <email>	-e	电子邮件	New email address.
--name <name>	-n	字符串	New first name.
--surname <surname>		字符串	New last name.

示例

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

数据形状（--输出 json）

{ "Code": "UserUpdated" }

uip admin users delete

按 ID 删除用户。

参数

名称	必填	用途
<user-id>	是	User ID (UUID).

示例

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

数据形状（--输出 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.

选项

长	短	值	必填	描述
--email <emails>	-e	comma-separated	是	One or more email addresses to invite.
--name <name>	-n	字符串	否	First name applied to every invited user.
--surname <surname>		字符串	否	Last name applied to every invited user.

示例

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

数据形状（--输出 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.

示例

uip admin groups list

数据形状（--输出 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.

参数

名称	必填	用途
<group-id>	是	Group ID (UUID). Find it with groups list.

示例

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

数据形状（--输出 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.

参数

名称	必填	用途
<name>	是	Group name.

示例

uip admin groups create "DevOps Team"

数据形状（--输出 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").

参数

名称	必填	用途
<group-id>	是	Group ID (UUID).

选项

长	短	值	必填	描述
--name <name>	-n	字符串	是	New group name.

示例

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

数据形状（--输出 json）

{ "Code": "GroupUpdated" }

uip admin groups delete

Delete a group by ID.

参数

名称	必填	用途
<group-id>	是	Group ID (UUID).

示例

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

数据形状（--输出 json）

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

uip admin groups members list

List a group's members.

参数

名称	必填	用途
<group-id>	是	Group ID (UUID).

选项

长	短	值	默认	描述
--limit <number>	-l	整数	50	Number of items to return.
--offset <number>		整数	0	Number of items to skip.

示例

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

数据形状（--输出 json）

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

uip admin groups members add

Add one or more users to a group.

备注：

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.

参数

名称	必填	用途
<group-id>	是	Group ID (UUID).

选项

长	值	必填	描述
--user-ids <ids>	comma-separated	是	User IDs to add. Find them with users list.

示例

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

数据形状（--输出 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.

参数

名称	必填	用途
<group-id>	是	Group ID (UUID).

选项

长	值	必填	描述
--user-ids <ids>	comma-separated	是	User IDs to remove. Must be current members.

示例

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

数据形状（--输出 json）

{ "Code": "GroupMembersRevoked" }

相关内容

• 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).

另请参阅

• 全局选项
• 退出代码