UiPath Documentation
uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。

uip 管理员用户

“uip admin Users”和“uip admingroups”的语法和选项,用于管理 Identity Server 目录用户、组和组成员身份。

uip admin users 和 uip admin groups 管理组织分区中的本地 Identity Server 用户和组 — 登录背后的目录级别的身份,而不是 Orchestrator 级别的角色分配。此处设置有两个独立的命令组:users(创建/读取/更新/删除/邀请目录用户)和 groups(创建/读取/更新/删除组,以及成员身份管理)。

--organization用于两组中的大多数动词,但已弃用并被忽略— 组织始终派生自您当前的登录上下文。若直接传递参数,系统会打印警告 (--organization is deprecated and ignored; organization is derived from login context),但不会产生任何效果。

大纲​

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

动词​

组动词用途
userslist列出分区中的用户(可搜索、可排序、已分页)。
usersget按 ID 获取用户的完整详细信息。
userscreate新建本地用户。
usersupdate更新用户的电子邮件、名字或姓氏。
usersdelete按 ID 删除用户。
usersinvite通过电子邮件邀请一位或多位用户。
groupslist列出分区中的所有组。
groupsget按 ID 获取组的详细信息。
groupscreate创建新的本地组。
groupsupdate重命名组。
groupsdelete按 ID 删除组。
groups memberslist列出组的成员。
groups membersadd向组中添加一个或多个用户。
groups membersrevoke从组中删除一个或多个用户。

uip 管理员用户列表​

列出分区中的用户。返回用户 ID、用户名、电子邮件、名称和创建时间。

选项​

长短值默认描述
--search <term>-s字符串—按名称或电子邮件搜索用户。
--sort-by <field>字符串—对字段进行排序,例如UserName,Email。
--sort-order <direction>asc|descasc排序方向
--limit <number>-l整数50 (DEFAULT_PAGE_SIZE):要返回的项目数。
--offset <number>整数0要跳过的项目数量。
--login-validity <minutes>整数—覆盖此调用的令牌有效性。

示例​

uip admin users list --limit 5
uip admin users list --limit 5

数据形状(--输出 json)​

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

uip 管理员用户获取​

按 ID 获取用户详细信息。

参数​

名称必填用途
<user-id>是用户 ID (UUID)。使用 users list 查找。

示例​

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

数据形状(--输出 json)​

{
  "Code": "UserDetails",
  "Data": {
    "id": "a1b2c3d4-0000-0000-0000-000000000001",
    "userName": "admin@example.com",
    "email": "admin@example.com",
    "name": "Admin",
    "surname": "User",
    "displayName": "Admin User",
    "creationTime": "2026-01-15T10:00:00.000Z"
  }
}
{
  "Code": "UserDetails",
  "Data": {
    "id": "a1b2c3d4-0000-0000-0000-000000000001",
    "userName": "admin@example.com",
    "email": "admin@example.com",
    "name": "Admin",
    "surname": "User",
    "displayName": "Admin User",
    "creationTime": "2026-01-15T10:00:00.000Z"
  }
}

uip 管理员用户创建​

新建本地用户。

参数​

名称必填用途
<username>是新用户的用户名。

选项​

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

示例​

uip admin users create newuser --email "user@example.com" --name "John" --surname "Doe"
uip admin users create newuser --email "user@example.com" --name "John" --surname "Doe"

数据形状(--输出 json)​

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

uip 管理员用户更新​

更新现有用户的电子邮件、名字或姓氏。至少有一个字段为必填 — 如果没有字段,则在任何网络调用之前调用会导致客户端 ("No fields to update") 失败。

参数​

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

选项​

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

示例​

uip admin users update a1b2c3d4-0000-0000-0000-000000000001 --name "Jane" --surname "Doe" --email "jane@example.com"
uip admin users update a1b2c3d4-0000-0000-0000-000000000001 --name "Jane" --surname "Doe" --email "jane@example.com"

数据形状(--输出 json)​

{ "Code": "UserUpdated" }
{ "Code": "UserUpdated" }

uip 管理员用户删除​

按 ID 删除用户。

参数​

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

示例​

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

数据形状(--输出 json)​

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

邀请 uip 管理员用户​

通过电子邮件邀请一位或多位用户。发送加入组织的邀请。

选项​

长短值必填描述
--email <emails>-e逗号分隔是要邀请的一个或多个电子邮件地址。
--name <name>-n字符串否应用于每个受邀用户的名字。
--surname <surname>字符串否已应用于每个受邀用户的姓氏。

示例​

uip admin users invite --email "user@example.com"
uip admin users invite --email "user@example.com"

数据形状(--输出 json)​

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

uip 管理员组列表​

列出分区中的所有组。返回组的 ID、名称、类型和创建时间。无筛选/分页选项 — 一次返回所有内容。

示例​

uip admin groups list
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" }
  ]
}
{
  "Code": "GroupList",
  "Data": [
    { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Administrators", "displayName": "Administrators", "type": "BuiltIn", "creationTime": "2026-01-15T10:00:00.000Z" }
  ]
}

获取uip管理员组​

按 ID 获取组详细信息。

参数​

名称必填用途
<group-id>是组 ID (UUID)。使用 groups list 查找。

示例​

uip admin groups get a1b2c3d4-0000-0000-0000-000000000001
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" } }
{ "Code": "GroupDetails", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Administrators", "displayName": "Administrators", "type": "BuiltIn", "creationTime": "2026-01-15T10:00:00.000Z" } }

uip 管理员组创建​

创建新的本地组。

参数​

名称必填用途
<name>是组名称。

示例​

uip admin groups create "DevOps Team"
uip admin groups create "DevOps Team"

数据形状(--输出 json)​

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

该命令在调用 API 之前为组的 id 生成客户端 UUID — 如果未提供 ID,服务器将拒绝创建组,并返回 409。

UIP 管理员组更新​

重命名组。--name 是唯一可更新的字段,并且为必填字段 — 省略它会导致客户端失败 ("No fields to update")。

参数​

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

选项​

长短值必填描述
--name <name>-n字符串是新组名称。

示例​

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

数据形状(--输出 json)​

{ "Code": "GroupUpdated" }
{ "Code": "GroupUpdated" }

UIP管理员组删除​

按 ID 删除组。

参数​

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

示例​

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

数据形状(--输出 json)​

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

UIP 管理员组成员列表​

列出组的成员。

参数​

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

选项​

长短值默认描述
--limit <number>-l整数50要返回的项目数。
--offset <number>整数0要跳过的项目数量。

示例​

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

数据形状(--输出 json)​

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

添加 UIP 管理员组成员​

向组中添加一个或多个用户。

备注:

以读取-修改-写入方式实现:该命令获取组的当前名称,然后使用 directoryUserIDsToAdd 调用组更新 API,这与 groups update 的基础操作相同,只是有效负载字段不同。没有专用的“添加成员”按钮API 调用。

参数​

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

选项​

长值必填描述
--user-ids <ids>逗号分隔是要添加的用户 ID。使用 users list 查找它们。

示例​

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

数据形状(--输出 json)​

{ "Code": "GroupMembersAdded" }
{ "Code": "GroupMembersAdded" }

UIP 管理员组成员撤销​

从组中删除一个或多个用户。与 members add 相同的读取-修改-写入机制,但使用 directoryUserIDsToRemove。

参数​

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

选项​

长值必填描述
--user-ids <ids>逗号分隔是要删除的用户 ID。必须是当前成员。

示例​

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

数据形状(--输出 json)​

{ "Code": "GroupMembersRevoked" }
{ "Code": "GroupMembersRevoked" }

另请参阅​

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新