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

UIP 或用户

“uip 或用户”的语法和选项，用于管理 Orchestrator 租户用户及其文件夹和角色分配。

uip or users 在租户级别管理 Orchestrator 用户。Orchestrator 用户由身份服务 (IS) 提供支持 — 此工具不会从头开始创建独立用户。取而代之的是， users import会引用现有IS 目录主体（用户、组、机器人帐户或外部应用程序），并将其配置到租户中；然后， users update编辑位于 Orchestrator 端的租户端属性（许可证、会话权限、Unattended 凭据）。没有 users delete — 用户删除是通过身份服务或 Orchestrator 门户管理的，而不是此 CLI。有关文件夹级别的角色管理，请参阅uip or roles 。

大纲​

uip or users list [options]
uip or users list-in-folder [--folder-path <path> | --folder-key <key>] [options]
uip or users list-available [--folder-path <path> | --folder-key <key>] [options]
uip or users get <user-key>
uip or users import (--username <name> | --directory-id <id>) --type <type> [--folder-path <path> | --folder-key <key>] [--role-keys <keys>]
uip or users assign --user-key <key> [--folder-path <path> | --folder-key <key>] [--role-keys <keys>]
uip or users unassign --user-key <key> [--folder-path <path> | --folder-key <key>]
uip or users update <user-key> [options]
uip or users current
uip or users assign-roles <user-key> --role-keys <keys>
uip or users list [options]
uip or users list-in-folder [--folder-path <path> | --folder-key <key>] [options]
uip or users list-available [--folder-path <path> | --folder-key <key>] [options]
uip or users get <user-key>
uip or users import (--username <name> | --directory-id <id>) --type <type> [--folder-path <path> | --folder-key <key>] [--role-keys <keys>]
uip or users assign --user-key <key> [--folder-path <path> | --folder-key <key>] [--role-keys <keys>]
uip or users unassign --user-key <key> [--folder-path <path> | --folder-key <key>]
uip or users update <user-key> [options]
uip or users current
uip or users assign-roles <user-key> --role-keys <keys>

动词​

动词用途
list带有可选筛选器的租户用户列表。
list-in-folder列出分配到文件夹的用户及其文件夹级别角色。
list-available列出仍可分配至文件夹（尚未分配）的用户。
get通过密钥获取一个用户。
import将现有身份服务目录主体导入租户。
assign将用户分配到文件夹，并可以选择使用文件夹级别角色。
unassign从文件夹中删除用户。
update （别名 edit）更新用户的租户端属性（PATCH 语义）。
current返回当前经过身份验证的用户的详细信息。
assign-roles替换用户的租户级别角色分配。

uip 或用户列表​

列出租户中的用户。返回用户密钥 (GUID)、用户名、全名、电子邮件、类型和活动状态。

选项​

短长值默认描述
—--keyGUID—按用户密钥筛选（精确匹配）。
—--usernametext—按用户名筛选（包含匹配项）。
—--emailtext—按电子邮件地址筛选（包含匹配项）。
-l--limit数字50页面大小。
—--offset数字0跳过计数。
—--sort-by字段—OData 排序（例如， UserName asc ）。
—--all-fields标记关闭返回完整的 API 有效负载，而不是策划摘要。

示例​

uip or users list --limit 10
uip or users list --username admin
uip or users list --output-filter 'Data[].{key:Key, name:UserName}'
uip or users list --limit 10
uip or users list --username admin
uip or users list --output-filter 'Data[].{key:Key, name:UserName}'

数据形状（--输出 json）​

{
  "Code": "UserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "[email protected]",
      "FullName": "Admin User",
      "Email": "[email protected]",
      "Type": "User",
      "IsActive": true
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0 }
}
{
  "Code": "UserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "[email protected]",
      "FullName": "Admin User",
      "Email": "[email protected]",
      "Type": "User",
      "IsActive": true
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0 }
}

uip 或文件夹中的用户列表​

列出分配到文件夹的用户及其文件夹级别角色。需要--folder-path或--folder-key 。

选项​

短长值默认描述
—--folder-path路径—目标文件夹。提供此项或--folder-key 。
—--folder-keyGUID—目标文件夹。提供此项或--folder-path 。
—--include-inherited标记关闭同时显示从父文件夹继承的用户。
-l--limit数字50页面大小。
—--offset数字0跳过计数。
—--sort-by字段Id descOData 排序。
—--all-fields标记关闭返回完整的 API 有效负载，而不是策划摘要。

示例​

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

数据形状（--输出 json）​

{
  "Code": "UserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "[email protected]",
      "FullName": "Admin User",
      "Type": "User",
      "IsInherited": false,
      "Roles": "Folder Administrator"
    }
  ]
}
{
  "Code": "UserList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "[email protected]",
      "FullName": "Admin User",
      "Type": "User",
      "IsInherited": false,
      "Roles": "Folder Administrator"
    }
  ]
}

uip 或用户列表-可用​

列出仍可分配给文件夹的租户用户。将返回的键与users assign或roles assign一起使用。

选项​

短长值默认描述
—--folder-path路径—目标文件夹。提供此项或--folder-key 。
—--folder-keyGUID—目标文件夹。提供此项或--folder-path 。
-s--searchtext—按用户名筛选（包含匹配项）。
-l--limit数字50页面大小。
—--offset数字0跳过计数。

示例​

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

数据形状（--输出 json）​

{
  "Code": "UserAvailableList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000003",
      "UserName": "[email protected]",
      "Roles": ""
    }
  ]
}
{
  "Code": "UserAvailableList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000003",
      "UserName": "[email protected]",
      "Roles": ""
    }
  ]
}

uip 或用户获取​

按 GUID 密钥获取用户。

参数​

名称必填用途
<user-key>是用户密钥 (GUID)。

选项​

短长值默认描述
—--all-fields标记关闭返回完整的 API 有效负载，而不是策划摘要。

示例​

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

数据形状（--输出 json）​

{
  "Code": "User",
  "Data": {
    "Key": "d4e5f6a7-0000-0000-0000-000000000001",
    "UserName": "[email protected]",
    "FullName": "Admin User",
    "Email": "[email protected]",
    "Type": "User",
    "IsActive": true
  }
}
{
  "Code": "User",
  "Data": {
    "Key": "d4e5f6a7-0000-0000-0000-000000000001",
    "UserName": "[email protected]",
    "FullName": "Admin User",
    "Email": "[email protected]",
    "Type": "User",
    "IsActive": true
  }
}

uip 或用户导入​

将目录主体（身份服务用户、组、机器人帐户或外部应用程序）导入此租户。这是此 CLI 配置新租户用户的唯一方法；没有独立的“创建用户”功能动词，因为 Orchestrator 用户始终有 IS 主体提供支持。

通过 --username 或 --directory-id 引用现有 IS 主体，并加上 --type 以声明它是哪种主体（CLI 不会猜测）。可选择性地在与 --folder-path/--folder-key 和 --role-keys 的同一调用中分配文件夹角色 — 必须同时提供文件夹和角色，或者都不提供。--directory-id 导入具有幂等性：按目录 ID 导入已导入的主体时，不会返回现有租户记录，而不会失败。

机器人帐户和外部应用程序必须使用 --directory-id（IS UUID）导入— Orchestrator 无法通过 <domain>\<name> 解析目录用户的方式来解析它们。查找包含 uip admin robot-accounts list --search <name> 或 uip admin external-apps list 的 ID。

参数和所需的标识符​

名称必填用途
--username--username/--directory-id 之一身份服务用户名 (通常为电子邮件)。
--directory-id--username/--directory-id 之一身份服务目录标识符（OIDC 主题/IS UUID）。对于DirectoryRobot和DirectoryExternalApplication类型为必填项。

选项​

短长值默认描述
—--typeDirectoryUser | DirectoryGroup | DirectoryRobot | DirectoryExternalApplication必填目录主体类型。
—--domaintext—在身份服务中配置的目录域名。仅配置了 AD 域的本地部署环境需要。
—--folder-path路径—要将导入的主体分配到的文件夹。与 --role-keys 一起使用。
—--folder-keyGUID—--folder-path 的文件夹替代选项。与 --role-keys 一起使用。
—--role-keysCSV 格式的 GUID—要授予的文件夹角色 GUID。需要文件夹选项；不带 --role-keys 的文件夹选项也会被拒绝。

示例​

uip or users import --username alice@example.com

uip or users import --username alice@example.com \
    --folder-path Shared --role-keys a1b2c3d4-0000-0000-0000-000000000001

# Robot account — directory ID required
uip or users import --directory-id 11111111-2222-3333-4444-555555555555 \
    --type DirectoryRobot
uip or users import --username [email protected]

uip or users import --username [email protected] \
    --folder-path Shared --role-keys a1b2c3d4-0000-0000-0000-000000000001

# Robot account — directory ID required
uip or users import --directory-id 11111111-2222-3333-4444-555555555555 \
    --type DirectoryRobot

数据形状（--输出 json）​

{
  "Code": "UserImported",
  "Data": {
    "UserName": "[email protected]",
    "Type": "DirectoryUser",
    "AssignedFolderPath": "Shared",
    "AssignedRoleKeys": ["a1b2c3d4-0000-0000-0000-000000000001"]
  }
}
{
  "Code": "UserImported",
  "Data": {
    "UserName": "[email protected]",
    "Type": "DirectoryUser",
    "AssignedFolderPath": "Shared",
    "AssignedRoleKeys": ["a1b2c3d4-0000-0000-0000-000000000001"]
  }
}

当 AlreadyImported: true 与租户中已存在的主体匹配时添加 --directory-id。

UIP 或用户分配​

将用户分配到文件夹，并可以选择使用文件夹级别角色。

备注：

注意 — 对角色具有破坏性。如果传递--role-keys ，则服务器会将用户在目标文件夹中的所有现有角色替换为提供的角色 — 不在有效负载中的角色将被静默删除。要保留现有角色，请先使用 roles user-roles list <principal-name> --type <type> 读取这些角色，并将所需的完整并集传递给 --role-keys。对于角色的附加租户级别角色成员身份，请改用 roles users set。

选项​

短长值默认描述
—--user-keyGUID必填用户密钥。
—--role-keysCSV 格式的 GUID—文件夹范围角色 GUID。
—--folder-path路径—目标文件夹。提供此项或--folder-key 。
—--folder-keyGUID—目标文件夹。

示例​

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

数据形状（--输出 json）​

{
  "Code": "UserAssigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "Status": "Assigned successfully"
  }
}
{
  "Code": "UserAssigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "Status": "Assigned successfully"
  }
}

uip 或用户取消分配​

从文件夹中删除用户。用户不会删除 — 仅删除其分配的文件夹。

选项​

短长值默认描述
—--user-keyGUID必填用户密钥。
—--folder-path路径—要从中删除的文件夹。提供此项或--folder-key 。
—--folder-keyGUID—要从中删除的文件夹。

示例​

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

数据形状（--输出 json）​

{
  "Code": "UserUnassigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "Status": "Unassigned successfully"
  }
}
{
  "Code": "UserUnassigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "FolderPath": "Shared",
    "Status": "Unassigned successfully"
  }
}

uip 或用户更新​

通过密钥 (GUID) 更新用户的租户端属性。读取当前值，合并提供的字段，然后保存。至少提供一个选项。

edit 是此动词的已注册别名，uip or users edit 的作用与 uip or users update 相同。

可可靠编辑：许可证配置文件、会话标志和 Unattended Robot 凭据。身份属性（--name、--surname、--email、--type）为 API 接受，但对于目录主体 (DirectoryUser/Group/Robot/ExternalApplication)，这些字段通常从身份服务同步 — 此处更改它们只会编辑 Orchestrator 端缓存的副本，并且可能会在下次 IS 同步时被覆盖。对于持久身份更改，请直接编辑 IS 主体。

此命令不会公开角色分配 — 使用users assign （文件夹角色）或users assign-roles （租户角色）；当前租户角色列表始终会不加更改地重新发送，因此更新永远不会涉及该列表。

参数​

名称必填用途
<user-key>是用户密钥 (GUID)。

选项​

身份（Orchestrator 端缓存仅适用于目录主体）​
长值描述
--nametext新名字。
--surnametext新姓氏。
--emailtext新电子邮件地址。
--typetext新的用户类型（例如 User、DirectoryUser）。
许可证和会话权限​
长值描述
--license-typetext例如 Attended、Unattended、StudioPro。
--allow-unattended / --deny-unattended标记允许或拒绝执行 Unattended 作业。
--allow-attended / --deny-attended标记允许或拒绝 Attended 会话。
--allow-login / --deny-login标记允许或拒绝 Orchestrator 登录。
--allow-personal-workspace / --deny-personal-workspace标记允许或拒绝个人工作区。
--active / --inactive标记激活或停用用户。
Unattended 执行凭据​
长值描述
--unattended-usernametext用于 Unattended 执行的 Windows 帐户（例如 DOMAIN\user）。
--unattended-passwordtext“密码”或“外部密码引用名称”（对于只读凭据存储）。
--credential-store-keyGUIDUnattended 执行凭据的凭据存储。使用 credential-stores list 进行查找。
--credential-typeDefault | SmartCard凭据类型。
--limit-concurrent / --no-limit-concurrent标记允许或禁止在多台计算机上并发执行。

如果您为没有现有 UnattendedRobot 记录的用户设置了任何无人值守凭据标志，则需要同时使用 --unattended-username 和 --unattended-password—Orchestrator 会静默丢弃不完整的记录，因此 CLI 拒绝提交记录，而不是报告成功。编辑现有记录会接受这些标志的任何子集。

示例​

uip or users update d4e5f6a7-0000-0000-0000-000000000001 --email newmail@example.com

uip or users update d4e5f6a7-0000-0000-0000-000000000001 \
    --allow-unattended --license-type Unattended \
    --unattended-username DOMAIN\\bot --unattended-password s3cret

uip or users update d4e5f6a7-0000-0000-0000-000000000001 --inactive \
    --output-filter 'Data.Status'
uip or users update d4e5f6a7-0000-0000-0000-000000000001 --email [email protected]

uip or users update d4e5f6a7-0000-0000-0000-000000000001 \
    --allow-unattended --license-type Unattended \
    --unattended-username DOMAIN\\bot --unattended-password s3cret

uip or users update d4e5f6a7-0000-0000-0000-000000000001 --inactive \
    --output-filter 'Data.Status'

数据形状（--输出 json）​

{
  "Code": "UserUpdated",
  "Data": { "Key": "d4e5f6a7-0000-0000-0000-000000000001", "Status": "Updated successfully" }
}
{
  "Code": "UserUpdated",
  "Data": { "Key": "d4e5f6a7-0000-0000-0000-000000000001", "Status": "Updated successfully" }
}

uip 或用户当前值​

返回当前经过身份验证的用户。用于验证会话和发现自己的用户密钥。

选项​

短长值默认描述

示例​

uip or users current
uip or users current --output-filter 'Data.Key'
uip or users current --output table
uip or users current
uip or users current --output-filter 'Data.Key'
uip or users current --output table

数据形状（--输出 json）​

与User形状相同的users get 。

uip 或用户分配角色​

将租户级别角色分配给用户。

备注：

注意 — 破坏性。服务器使用通过--role-keys传递的密钥替换用户的整个租户级别角色列表 — 不在有效负载中的角色将被静默删除。要保留现有租户角色，请先使用 roles user-roles list <principal-name> --type <type> 读取这些角色，并将所需的完整并集传递给 --role-keys。与 users assign（文件夹级别角色）不同，这设置了适用于整个租户的角色。

参数​

名称必填用途
<user-key>是用户密钥 (GUID)。

选项​

短长值默认描述
—--role-keysCSV 格式的 GUID必填要在租户作用域内分配的角色 GUID。

示例​

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

数据形状（--输出 json）​

{
  "Code": "UserRolesAssigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "RolesAssigned": 1,
    "Status": "Assigned successfully"
  }
}
{
  "Code": "UserRolesAssigned",
  "Data": {
    "UserKey": "d4e5f6a7-0000-0000-0000-000000000001",
    "RolesAssigned": 1,
    "Status": "Assigned successfully"
  }
}

退出代码​

请参阅退出代码。没有动词特定的覆盖。

  • uip or roles — 管理角色、角色-用户成员身份和主体权限检查（ roles user-roles list 、 roles user-permissions list ）。
  • uip or folders — 在unassign users assign文件夹密钥。
  • uip or jobs — 尤其是jobs start --user-keys 。

另请参阅​

此页面有帮助吗？

连接

需要帮助? 支持

想要了解详细内容？ UiPath Academy

有问题? UiPath 论坛

保持更新