uipath-cli
latest
false
重要 :
请注意,此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
UiPath CLI 用户指南
uip agent list和uip agent share都在 Studio Web解决方案上运行,即智能体项目的云端表示。list枚举对当前用户可见的解决方案; share管理用户和组对单个解决方案的访问权限。它们在这里分组是因为两者都是纯 Studio Web 管理动词,不同于uip agent file中的文件级别操作和deploy / run中的 Orchestrator 端操作。
这两个动词都需要活动的 CLI 会话 ( uip login )。
UIP 智能体列表
列出 Studio Web 中的解决方案,可选择按关键字筛选。
大纲
uip agent list [-s <query>] [-l <n>] [--login-validity <minutes>]
uip agent list [-s <query>] [-l <n>] [--login-validity <minutes>]
参数
无。
选项
| 标记 | 默认 | 用途 |
|---|---|---|
-s, --search <query> | — | 已应用于 Studio WebSearchSolutionsAndProjects端点的关键字筛选器。 |
-l, --limit <n> | 20 | 最大结果数量。作为pagingOptions.limit查询参数发送。 |
--login-validity <minutes> | 10 | 令牌有效期的最短分钟数要求。 |
示例
# Simplest — list up to 20 solutions
uip agent list
# Filter by keyword
uip agent list --search invoice
# Page through larger result sets
uip agent list --limit 100
# Simplest — list up to 20 solutions
uip agent list
# Filter by keyword
uip agent list --search invoice
# Page through larger result sets
uip agent list --limit 100
数据形状(--输出 json)
{
"Code": "AgentList",
"Data": [
{
"Name": "Email Triage",
"Id": "a1b2c3d4-0000-0000-0000-000000000001",
"Status": "Completed",
"PublishStatus": "Published",
"LastModified": "2025-04-10T14:30:00Z",
"Projects": 2
}
]
}
{
"Code": "AgentList",
"Data": [
{
"Name": "Email Triage",
"Id": "a1b2c3d4-0000-0000-0000-000000000001",
"Status": "Completed",
"PublishStatus": "Published",
"LastModified": "2025-04-10T14:30:00Z",
"Projects": 2
}
]
}
空结果集会生成Data: { "Message": "No solutions found" }而不是空数组。Projects是嵌套在解决方案中的项目的计数,而不是列表。
UIP 智能体共享
管理用户和组对 Studio Web 解决方案的访问权限。三个子命令: add 、 list和remove 。
大纲
uip agent share add <solutionId> <entityId> [--permission <perm>] [--group] [--login-validity <minutes>]
uip agent share list <solutionId> [--login-validity <minutes>]
uip agent share remove <solutionId> <entityId> [--group] [--login-validity <minutes>]
uip agent share add <solutionId> <entityId> [--permission <perm>] [--group] [--login-validity <minutes>]
uip agent share list <solutionId> [--login-validity <minutes>]
uip agent share remove <solutionId> <entityId> [--group] [--login-validity <minutes>]
uip 智能体共享
向用户或组授予访问权限。
参数
<solutionId>(必填) — 解决方案 UUID。<entityId>(必填) — 用户或组 UUID。
选项
| 标记 | 默认 | 用途 |
|---|---|---|
--permission <perm> | write | 权限级别。以下组织之一: none 、 read 、 write 、 publish和readWritePublish 。不区分大小写;值无效,并显示验证错误。 |
--group | 关闭 (用户) | 将<entityId>视为组而非用户。 |
--login-validity <minutes> | 10 | 令牌有效期的最短分钟数要求。 |
示例
# Grant write access to a user
uip agent share add \
a1b2c3d4-0000-0000-0000-000000000001 \
a1b2c3d4-0000-0000-0000-000000000501 \
--permission write
# Grant read-only access to a group
uip agent share add <solutionId> <groupId> --permission read --group
# Full access (read + write + publish)
uip agent share add <solutionId> <userId> --permission readWritePublish
# Grant write access to a user
uip agent share add \
a1b2c3d4-0000-0000-0000-000000000001 \
a1b2c3d4-0000-0000-0000-000000000501 \
--permission write
# Grant read-only access to a group
uip agent share add <solutionId> <groupId> --permission read --group
# Full access (read + write + publish)
uip agent share add <solutionId> <userId> --permission readWritePublish
Data shape (--output json)
{
"Code": "AgentShare",
"Data": {
"Status": "Solution shared successfully",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"SharedWith": "a1b2c3d4-0000-0000-0000-000000000501",
"IsGroup": false,
"Permission": "write"
}
}
{
"Code": "AgentShare",
"Data": {
"Status": "Solution shared successfully",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"SharedWith": "a1b2c3d4-0000-0000-0000-000000000501",
"IsGroup": false,
"Permission": "write"
}
}
uip 智能体共享列表
列出有权访问解决方案的用户和组。
参数
<solutionId>(必填) — 解决方案 UUID。
选项
Only --login-validity.
示例
uip agent share list a1b2c3d4-0000-0000-0000-000000000001
uip agent share list a1b2c3d4-0000-0000-0000-000000000001
Data shape (--output json)
{
"Code": "AgentShareList",
"Data": [
{
"Id": "a1b2c3d4-0000-0000-0000-000000000501",
"Name": "Jane Doe",
"Email": "jane@example.com",
"IsGroup": false,
"Permission": "write"
}
]
}
{
"Code": "AgentShareList",
"Data": [
{
"Id": "a1b2c3d4-0000-0000-0000-000000000501",
"Name": "Jane Doe",
"Email": "jane@example.com",
"IsGroup": false,
"Permission": "write"
}
]
}
空响应将返回Data: { "Message": "No sharing permissions found for this solution" } 。
删除 UIP 智能体共享
撤销用户或组的访问权限。
参数
<solutionId>(必填) — 解决方案 UUID。<entityId>(必填) — 用户或组 UUID。
选项
| 标记 | 默认 | 用途 |
|---|---|---|
--group | 关闭 (用户) | 将<entityId>视为组而非用户。 |
--login-validity <minutes> | 10 | 令牌有效期的最短分钟数要求。 |
示例
uip agent share remove a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000501
uip agent share remove a1b2c3d4-0000-0000-0000-000000000001 a1b2c3d4-0000-0000-0000-000000000501
Data shape (--output json)
{
"Code": "AgentShareRemove",
"Data": {
"Status": "Access removed successfully",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"RemovedEntity": "a1b2c3d4-0000-0000-0000-000000000501"
}
}
{
"Code": "AgentShareRemove",
"Data": {
"Status": "Access removed successfully",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"RemovedEntity": "a1b2c3d4-0000-0000-0000-000000000501"
}
}
相关内容
uip agent push— 导入项目并获取此处使用的SolutionId。uip agent pull— 下载list列出的解决方案。uip agent file— 列出、下载和上传解决方案项目中的文件。