uipath-cli
latest
false
重要 :
请注意,此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
UiPath CLI 用户指南
uip platform groups管理基于组的许可证分配规则。规则将一组用户捆绑包(以及可选的每个捆绑包配额)附加到一个目录组;组成员会自动租赁授权捆绑包。使用rules get列出组织中每个组的规则,使用rules details检查一个组的规则及其成员级别租约,使用rules set配置权限和配额。
大纲
uip platform groups rules <verb> [options] [<group>]
uip platform groups rules <verb> [options] [<group>]
动词
| 动词 | 用途 |
|---|---|
get | 列出组许可证分配规则,其中包含配额配置和当前使用情况。已分页。 |
details | 获取某个组的规则,其中包含组成员和每个成员租赁的捆绑包的分页列表。 |
set | 设置(或替换)组的用户捆绑包分配规则和可选的每捆绑包配额。 |
组解析
details和set接受<group>位置参数,即名称前缀。CLI 搜索目录组,并且需要正好一个匹配项:
- 无匹配项 →
"No directory group found matching '<input>'."出错。 - 多个匹配项 → 列出候选对象时出错,以便您优化输入。
获取 UIP 平台组规则
列出组在整个组织中的许可证分配规则。每一行是一对(group, bundle) ;包含多个授权捆绑包的组每个捆绑包生成一行。响应包括组自己的每个捆绑包配额 ( quota ) 和该配额的当前使用情况 ( currentUsage ),以及指示该组是否配置为从外部许可租赁捆绑包的useExternalLicense标志。
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--limit | 数字 | 50 | 要返回的最大结果数。 |
--offset | 数字 | 0 | 要跳过的结果数量。 |
--sort-by | 字段 | — | 要排序的字段(例如name )。 |
--sort-order | 枚举 | — | 排序顺序: Asc或Desc 。 |
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。覆盖从当前登录解析解析的组织。 |
示例
uip platform groups rules get --limit 50
uip platform groups rules get --limit 50
数据形状(--输出 json)
{
"Code": "GroupRules",
"Data": [
{
"groupId": "35551807-06b1-4cda-90a1-2fb84851eee7",
"groupName": "RPA Developers",
"code": "RPADEVPRONU",
"name": "RPADEVPRONU",
"quota": 25,
"currentUsage": 12,
"useExternalLicense": false
}
]
}
{
"Code": "GroupRules",
"Data": [
{
"groupId": "35551807-06b1-4cda-90a1-2fb84851eee7",
"groupName": "RPA Developers",
"code": "RPADEVPRONU",
"name": "RPADEVPRONU",
"quota": 25,
"currentUsage": 12,
"useExternalLicense": false
}
]
}
响应还包含分页元数据(已返回、上限、偏移量、总计)。
UIP Platform 组规则详细信息
获取组的带配额的许可证分配规则,并展平为每(user, bundle leased)一行。尚无租约的用户显示为单个行,捆绑包列为空。用户列表已分页;使用--limit和--offset对其进行分页。标头摘要(标题为捆绑包、配额为used/limit 、 useExternalLicense )将写入标准错误(stderr),因此不会干扰标准输出上的 JSON 数据。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<group> | 是 | 组标识符(名称前缀;必须与一个目录组完全匹配)。 |
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--limit | 数字 | 50 | 要返回的最大用户数。 |
--offset | 数字 | 0 | 要跳过的用户数。 |
--sort-by | 字段 | — | 用于对用户进行排序的字段(例如name )。 |
--sort-order | 枚举 | — | 用户排序顺序: Asc或Desc 。 |
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。覆盖从当前登录解析解析的组织。 |
示例
uip platform groups rules details "RPA Developers" --limit 100
uip platform groups rules details "RPA Developers" --limit 100
数据形状(--输出 json)
{
"Code": "GroupRuleDetails",
"Data": [
{
"userDisplayName": "Dan Dinu",
"email": "dan.dinu@uipath.com",
"lastInUse": "2026-05-10T08:15:00.000Z",
"orphan": false,
"bundleCode": "RPADEVPRONU",
"bundleName": "RPADEVPRONU",
"quota": 25,
"currentUsage": 12
}
]
}
{
"Code": "GroupRuleDetails",
"Data": [
{
"userDisplayName": "Dan Dinu",
"email": "dan.dinu@uipath.com",
"lastInUse": "2026-05-10T08:15:00.000Z",
"orphan": false,
"bundleCode": "RPADEVPRONU",
"bundleName": "RPADEVPRONU",
"quota": 25,
"currentUsage": 12
}
]
}
UIP 平台组规则集
为组设置用户捆绑包分配规则,可选择性地使用每个捆绑包的配额。在条目上省略quota意味着不会对该捆绑包强制执行配额。新规则将替换该组先前的捆绑包列表 — 未在--input中列出的捆绑包将从规则中删除。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<group> | 是 | 组标识符(名称前缀;必须与一个目录组完全匹配)。 |
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--input | 路径 | 必填 | 包含此规则的 JSON 文件的路径,例如[{"code":"RPADEVPRONU"},{"code":"ATTUNU","quota":10}] 。 |
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。覆盖从当前登录解析解析的组织。 |
示例
uip platform groups rules set "RPA Developers" \
--input ./group-rule.json
uip platform groups rules set "RPA Developers" \
--input ./group-rule.json
group-rule.json:
[
{ "code": "RPADEVPRONU", "quota": 25 },
{ "code": "ATTUNU" }
]
[
{ "code": "RPADEVPRONU", "quota": 25 },
{ "code": "ATTUNU" }
]
数据形状(--输出 json)
{
"Code": "GroupRuleSet",
"Data": [
{ "code": "RPADEVPRONU", "name": "RPADEVPRONU", "quota": 25, "currentUsage": 12 },
{ "code": "ATTUNU", "name": "ATTUNU", "quota": null, "currentUsage": null }
]
}
{
"Code": "GroupRuleSet",
"Data": [
{ "code": "RPADEVPRONU", "name": "RPADEVPRONU", "quota": 25, "currentUsage": 12 },
{ "code": "ATTUNU", "name": "ATTUNU", "quota": null, "currentUsage": null }
]
}
退出代码
请参阅退出代码。没有动词特定的覆盖。
相关命令
uip platform users— 直接用户捆绑包分配;users licenses get显示成员从每个组规则中租赁的捆绑包。uip platform tenants— 租户级别的运行时和消耗性分配。
另请参阅
- 全局选项。