uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
uip admin 机器人帐户
“uip admin robot-accounts”、“uip adminpat”和“uip admin作用域”的语法和选项 — 非人类身份、个人访问令牌和 OAuth2 作用域引用。
三个相关的独立命令组: robot-accounts(用于 Unattended 自动化的非人工目录身份)、pat(用于 API 身份验证的个人访问令牌)和 scopes(对可用于执行 Unattended 自动化的每个 OAuth2 作用域的只读引用)。外部应用程序和 PAT)。
大纲
uip admin robot-accounts list [--search <term>] [--sort-by <field>] [--sort-order asc|desc] [--limit <n>] [--offset <n>]
uip admin robot-accounts get <robot-account-id>
uip admin robot-accounts create <name> [--display-name <name>]
uip admin robot-accounts update <robot-account-id> --display-name <name>
uip admin robot-accounts delete <robot-account-id>
uip admin pat list [--scope all] [--search <term>] [--limit <n>] [--offset <n>]
uip admin pat create --description <text> --expiration <date> --scope <scopes>
uip admin pat revoke <id>
uip admin pat regenerate <id> --expiration <date>
uip admin scopes list
uip admin robot-accounts list [--search <term>] [--sort-by <field>] [--sort-order asc|desc] [--limit <n>] [--offset <n>]
uip admin robot-accounts get <robot-account-id>
uip admin robot-accounts create <name> [--display-name <name>]
uip admin robot-accounts update <robot-account-id> --display-name <name>
uip admin robot-accounts delete <robot-account-id>
uip admin pat list [--scope all] [--search <term>] [--limit <n>] [--offset <n>]
uip admin pat create --description <text> --expiration <date> --scope <scopes>
uip admin pat revoke <id>
uip admin pat regenerate <id> --expiration <date>
uip admin scopes list
动词
| 组 | 动词 | 用途 |
|---|---|---|
robot-accounts | list | 列出分区中的机器人帐户。 |
robot-accounts | get | 按 ID 获取机器人帐户的详细信息。 |
robot-accounts | create | 创建新的机器人帐户。 |
robot-accounts | update | 更新机器人帐户的显示名称。 |
robot-accounts | delete | 按 ID 删除机器人帐户。 |
pat | list | 列出个人访问令牌(您的或具有 --scope all 的组织的)。 |
pat | create | 创建新的个人访问令牌。 |
pat | revoke | 撤销令牌。 |
pat | regenerate | 重新生成具有新到期时间的令牌。 |
scopes | list | 列出所有可用的 OAuth2 作用域,并按资源分组。 |
uip admin 机器人帐户列表
列出分区中的机器人帐户。返回帐户 ID、名称、显示名称和创建时间。
选项
| 长 | 短 | 值 | 默认 | 描述 |
|---|---|---|---|---|
--search <term> | -s | 字符串 | — | 按名称搜索。 |
--sort-by <field> | 字符串 | — | 对字段进行排序,例如Name。 | |
--sort-order <direction> | asc|desc | asc | 排序方向 | |
--limit <number> | -l | 整数 | 50 | 要返回的项目数。 |
--offset <number> | 整数 | 0 | 要跳过的项目数量。 |
示例
uip admin robot-accounts list --limit 5
uip admin robot-accounts list --limit 5
数据形状(--输出 json)
{
"Code": "RobotAccountList",
"Data": [
{ "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "automation-bot", "displayName": "Automation Bot", "creationTime": "2026-01-15T10:00:00.000Z" }
]
}
{
"Code": "RobotAccountList",
"Data": [
{ "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "automation-bot", "displayName": "Automation Bot", "creationTime": "2026-01-15T10:00:00.000Z" }
]
}
uip admin 机器人帐户获取
按 ID 获取机器人帐户详细信息。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<robot-account-id> | 是 | 机器人帐户 ID (UUID)。 |
示例
uip admin robot-accounts get a1b2c3d4-0000-0000-0000-000000000001
uip admin robot-accounts get a1b2c3d4-0000-0000-0000-000000000001
数据形状(--输出 json)
{ "Code": "RobotAccountDetails", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "automation-bot", "displayName": "Automation Bot", "creationTime": "2026-01-15T10:00:00.000Z", "groupIds": [] } }
{ "Code": "RobotAccountDetails", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "automation-bot", "displayName": "Automation Bot", "creationTime": "2026-01-15T10:00:00.000Z", "groupIds": [] } }
uip admin 机器人帐户创建
在分区中创建一个新的机器人帐户。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<name> | 是 | 机器人帐户名称。 |
选项
| 长 | 值 | 描述 |
|---|---|---|
--display-name <name> | 字符串 | 显示名称。省略时默认为 <name>。 |
示例
uip admin robot-accounts create "automation-bot" --display-name "Automation Bot"
uip admin robot-accounts create "automation-bot" --display-name "Automation Bot"
数据形状(--输出 json)
{ "Code": "RobotAccountCreated", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000002", "name": "automation-bot", "displayName": "Automation Bot" } }
{ "Code": "RobotAccountCreated", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000002", "name": "automation-bot", "displayName": "Automation Bot" } }
uip admin robot 帐户更新
更新机器人帐户的显示名称。--display-name 是唯一字段,并且实际上是必填字段 — 省略它会导致客户端失败 ("No fields to update")。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<robot-account-id> | 是 | 机器人帐户 ID (UUID)。 |
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--display-name <name> | 字符串 | 是 | 新显示名称。 |
示例
uip admin robot-accounts update a1b2c3d4-0000-0000-0000-000000000001 --display-name "Updated Bot"
uip admin robot-accounts update a1b2c3d4-0000-0000-0000-000000000001 --display-name "Updated Bot"
数据形状(--输出 json)
{ "Code": "RobotAccountUpdated" }
{ "Code": "RobotAccountUpdated" }
uip admin robot 帐户删除
按 ID 删除机器人帐户。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<robot-account-id> | 是 | 机器人帐户 ID (UUID)。 |
示例
uip admin robot-accounts delete a1b2c3d4-0000-0000-0000-000000000001
uip admin robot-accounts delete a1b2c3d4-0000-0000-0000-000000000001
数据形状(--输出 json)
{ "Code": "RobotAccountDeleted", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Status": "Deleted successfully" } }
{ "Code": "RobotAccountDeleted", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Status": "Deleted successfully" } }
uip 管理员点击列表
列出个人访问令牌。默认情况下,仅列出您自己的; --scope all(仅适用于管理员)列出组织中的每个令牌。
选项
| 长 | 值 | 描述 |
|---|---|---|
--scope <scope> | all | 仅接受 "all" — 任何其他值都会在客户端失败,并显示显式错误。省略此步骤,以仅列出您自己的令牌。 |
--search <term> | 字符串 | 按用户搜索词筛选。即使未传递--scope ,也会隐含--scope all 。 |
--limit <number> (-l) | 整数 | 默认 50。要返回的项目数。 |
--offset <number> | 整数 | 默认 0。要跳过的项目数。 |
示例
uip admin pat list
uip admin pat list
数据形状(--输出 json)
{
"Code": "PatList",
"Data": [
{ "id": "a1b2c3d4-0000-0000-0000-000000000001", "description": "CI/CD token", "expiration": "2027-01-15T00:00:00.000Z", "scopes": ["OR.Folders.Read"] }
]
}
{
"Code": "PatList",
"Data": [
{ "id": "a1b2c3d4-0000-0000-0000-000000000001", "description": "CI/CD token", "expiration": "2027-01-15T00:00:00.000Z", "scopes": ["OR.Folders.Read"] }
]
}
uip 管理员点击创建
创建新的个人访问令牌。令牌值仅返回一次,以后无法检索。
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--description <text> | 字符串 | 是 | 令牌的描述。 |
--expiration <date> | YYYY-MM-DD | 是 | 到期日期。严格验证 — 拒绝格式错误的日期和日历滚动(例如2027-02-30)。 |
--scope <scopes> | 逗号分隔 | 是 | 一个或多个作用域,例如OR.Folders.Read,OR.Jobs.Read。有关完整目录,请参阅scopes list 。 |
示例
uip admin pat create --description "CI/CD token" --expiration 2027-01-15 --scope "OR.Folders.Read,OR.Jobs.Read"
uip admin pat create --description "CI/CD token" --expiration 2027-01-15 --scope "OR.Folders.Read,OR.Jobs.Read"
数据形状(--输出 json)
{ "Code": "PatCreated", "Data": { "Token": "...", "Warning": "Save this token now. It will not be shown again." } }
{ "Code": "PatCreated", "Data": { "Token": "...", "Warning": "Save this token now. It will not be shown again." } }
uip adminpat 撤销
撤销个人访问令牌。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<id> | 是 | 令牌 ID (UUID)。使用 pat list 查找。 |
示例
uip admin pat revoke a1b2c3d4-0000-0000-0000-000000000001
uip admin pat revoke a1b2c3d4-0000-0000-0000-000000000001
数据形状(--输出 json)
{ "Code": "PatRevoked", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Status": "Revoked successfully" } }
{ "Code": "PatRevoked", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Status": "Revoked successfully" } }
uip adminpat 重新生成
重新生成具有新到期日期的个人访问令牌。与 create 一样,新的令牌值仅显示一次。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<id> | 是 | 令牌 ID (UUID)。 |
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--expiration <date> | YYYY-MM-DD | 是 | 新的到期日期。与 create 相同的严格验证。 |
示例
uip admin pat regenerate a1b2c3d4-0000-0000-0000-000000000001 --expiration 2028-01-15
uip admin pat regenerate a1b2c3d4-0000-0000-0000-000000000001 --expiration 2028-01-15
数据形状(--输出 json)
{ "Code": "PatRegenerated", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Token": "...", "Warning": "Save this token now. It will not be shown again." } }
{ "Code": "PatRegenerated", "Data": { "Id": "a1b2c3d4-0000-0000-0000-000000000001", "Token": "...", "Warning": "Save this token now. It will not be shown again." } }
uip 管理员作用域列表
列出可用于外部应用程序和个人访问令牌的所有 OAuth2 作用域,并按资源分组。只读,无全局以外的选项。
示例
uip admin scopes list
uip admin scopes list
数据形状(--输出 json)
{
"Code": "ScopesList",
"Data": [
{
"name": "UiPath.Orchestrator",
"displayName": "Orchestrator API Access",
"scopes": [
{ "name": "OR.Folders", "displayName": "OR.Folders", "type": "user" }
]
}
]
}
{
"Code": "ScopesList",
"Data": [
{
"name": "UiPath.Orchestrator",
"displayName": "Orchestrator API Access",
"scopes": [
{ "name": "OR.Folders", "displayName": "OR.Folders", "type": "user" }
]
}
]
}
每个作用域条目上的 type 为 "user"(委派,需要登录用户)或 "application"(仅限应用程序) — 区分 external-apps create 的 --user-scope/--app-scope 标志和 pat create的 --scope 标记绘制来源。
相关内容
uip admin users— 目录用户和组。uip admin external-apps— OAuth2 客户端注册,使用相同的作用域目录。uip admin smtp— 组织电子邮件配置。
另请参阅
- 大纲
- 动词
- uip admin 机器人帐户列表
- 选项
- 示例
- 数据形状(--输出 json)
- uip admin 机器人帐户获取
- 参数
- 示例
- 数据形状(--输出 json)
- uip admin 机器人帐户创建
- 参数
- 选项
- 示例
- 数据形状(--输出 json)
- uip admin robot 帐户更新
- 参数
- 选项
- 示例
- 数据形状(--输出 json)
- uip admin robot 帐户删除
- 参数
- 示例
- 数据形状(--输出 json)
- uip 管理员点击列表
- 选项
- 示例
- 数据形状(--输出 json)
- uip 管理员点击创建
- 选项
- 示例
- 数据形状(--输出 json)
- uip adminpat 撤销
- 参数
- 示例
- 数据形状(--输出 json)
- uip adminpat 重新生成
- 参数
- 选项
- 示例
- 数据形状(--输出 json)
- uip 管理员作用域列表
- 示例
- 数据形状(--输出 json)
- 相关内容
- 另请参阅