“uip platform Users”的语法和选项,通过许可证会计管理按用户的许可证捆绑包分配。
uip platform users 通过“许可证会计”以及每用户的消耗性充值和许可证/消耗使用情况报告,管理每个用户的许可证捆绑分配。此处存在三个独立的命令组:licenses(直接/组捆绑包分配)、top-ups(授权并跟踪消耗性充值)和 usage(每个用户的许可证消耗量)。
大纲
uip platform users licenses <verb> [options] [<user>]
uip platform users top-ups <verb> [options]
uip platform users usage <verb> [options] [<user>]
uip platform users licenses <verb> [options] [<user>]
uip platform users top-ups <verb> [options]
uip platform users usage <verb> [options] [<user>]
动词
| 组 | 动词 | 用途 |
|---|---|---|
licenses | set | 直接将用户捆绑包许可证分配给目录用户。 |
licenses | get | 列出目录用户当前拥有的用户捆绑包租户,以及每个租户的来源。 |
licenses | available | 获取用户捆绑包许可证的帐户级别摘要(总计、已分配、可用)。 |
top-ups | create | 向组织的有效消耗池中的用户授予充值权限。 |
top-ups | get | 检查充值授权作业的状态。 |
top-ups | request | 为自己请求充值;通知组织的管理员。 |
usage | list | 列出组织中具有许可证使用情况的用户。 |
usage | get | 显示每个用户的许可证使用情况(您自己的许可证使用情况或管理员查看其他用户的许可证使用情况)。 |
用户分辨率
set和get接受<user>位置参数,即名称或电子邮件前缀。CLI 通过“开头为”匹配搜索本地和目录用户,并且只需要一个匹配项:
- 无匹配项 →
"No directory user found matching '<input>'."出错。 - 多个匹配项 → 出错。最多可列出 10 个候选对象,以便您可以优化输入。
UIP Platform 用户许可证已设置
向目录用户分配用户捆绑包许可证。--input中的捆绑包将替换用户直接分配的捆绑包;从组规则继承的捆绑包不受此命令的影响。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<user> | 是 | 用户标识符(名称或电子邮件前缀;必须与一个目录用户完全匹配)。 |
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--input | 路径 | 必填 | 包含所需用户许可证分配的 JSON 文件的路径,例如[{"code":"RPADEVPRONU"},{"code":"ATTUNU"},{"code":"TSTNU"}] 。 |
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。覆盖从当前登录解析解析的组织。 |
示例
uip platform users licenses set "dan.dinu@uipath.com" \
--input ./user-bundles.json
uip platform users licenses set "dan.dinu@uipath.com" \
--input ./user-bundles.json
user-bundles.json:
[
{ "code": "RPADEVPRONU" },
{ "code": "ATTUNU" },
{ "code": "TSTNU" }
]
[
{ "code": "RPADEVPRONU" },
{ "code": "ATTUNU" },
{ "code": "TSTNU" }
]
数据形状(--输出 json)
{
"Code": "UserLicensesSet",
"Data": [
{ "code": "RPADEVPRONU", "name": "RPADEVPRONU" },
{ "code": "ATTUNU", "name": "ATTUNU" },
{ "code": "TSTNU", "name": "TSTNU" }
]
}
{
"Code": "UserLicensesSet",
"Data": [
{ "code": "RPADEVPRONU", "name": "RPADEVPRONU" },
{ "code": "ATTUNU", "name": "ATTUNU" },
{ "code": "TSTNU", "name": "TSTNU" }
]
}
uip platform 用户获取许可证
获取目录用户当前租用的用户捆绑包许可证。每一行都是一个租用的捆绑包;当租约继承自组规则时, source为"group"对于非组分配, "direct" 。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<user> | 是 | 用户标识符(名称或电子邮件前缀;必须与一个目录用户完全匹配)。 |
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。覆盖从当前登录解析解析的组织。 |
示例
uip platform users licenses get "dan.dinu@uipath.com"
uip platform users licenses get "dan.dinu@uipath.com"
数据形状(--输出 json)
{
"Code": "UserLicenses",
"Data": [
{
"source": "direct",
"code": "RPADEVPRONU",
"name": "RPADEVPRONU",
"leasedAt": "2026-04-15T10:30:00.000Z"
},
{
"source": "group",
"code": "ATTUNU",
"name": "ATTUNU",
"leasedAt": "2026-04-20T08:15:00.000Z"
}
]
}
{
"Code": "UserLicenses",
"Data": [
{
"source": "direct",
"code": "RPADEVPRONU",
"name": "RPADEVPRONU",
"leasedAt": "2026-04-15T10:30:00.000Z"
},
{
"source": "group",
"code": "ATTUNU",
"name": "ATTUNU",
"leasedAt": "2026-04-20T08:15:00.000Z"
}
]
}
UIP Platform 用户许可证可用
获取用户捆绑包许可证的帐户级别摘要:每个捆绑包存在多少席位 ( total )、已分配多少席位 ( allocated ),以及剩余可用席位 ( available )。在分配之前使用此命令以确认容量。
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。覆盖从当前登录解析解析的组织。 |
示例
uip platform users licenses available
uip platform users licenses available
数据形状(--输出 json)
{
"Code": "UserLicensesAvailable",
"Data": [
{ "code": "RPADEVPRONU", "name": "RPADEVPRONU", "total": 100, "allocated": 42, "available": 58 },
{ "code": "ATTUNU", "name": "ATTUNU", "total": 50, "allocated": 50, "available": 0 }
]
}
{
"Code": "UserLicensesAvailable",
"Data": [
{ "code": "RPADEVPRONU", "name": "RPADEVPRONU", "total": 100, "allocated": 42, "available": 58 },
{ "code": "ATTUNU", "name": "ATTUNU", "total": 50, "allocated": 50, "available": 0 }
]
}
UIP 平台用户充值
授予并跟踪每个用户的消耗性充值。系统会根据组织的有效消耗品自动解析来源池(首选 PLTU,否则为 AGU),您无需显式传递池。
创建 UIP 平台用户充值
向用户授予充值权限。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<user> | 是 | 用户标识符(名称或电子邮件前缀;必须与一个目录用户完全匹配)。 |
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--wait | 标记 | 关闭 | 等待充值作业完成,并报告是否已授予该作业。 |
--count | 整数 (1-100) | 1 | 要授予的充值单位数量。 |
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。 |
示例
uip platform users top-ups create "jane.doe@example.com"
uip platform users top-ups create "jane.doe@example.com" --wait
uip platform users top-ups create "jane.doe@example.com" --count 5
uip platform users top-ups create "jane.doe@example.com"
uip platform users top-ups create "jane.doe@example.com" --wait
uip platform users top-ups create "jane.doe@example.com" --count 5
数据形状(--输出 json)
没有--wait :
{
"Code": "TopUpStarted",
"Data": {
"jobId": "b3f1c2d4-0000-0000-0000-000000000009",
"status": "started",
"pool": "AGU",
"poolPercentConsumed": 42
}
}
{
"Code": "TopUpStarted",
"Data": {
"jobId": "b3f1c2d4-0000-0000-0000-000000000009",
"status": "started",
"pool": "AGU",
"poolPercentConsumed": 42
}
}
与 --wait 一起:
{
"Code": "TopUpCompleted",
"Data": {
"jobId": "b3f1c2d4-0000-0000-0000-000000000009",
"status": "completed",
"pool": "AGU",
"poolPercentConsumed": 42,
"granted": true,
"rejectionReason": null
}
}
{
"Code": "TopUpCompleted",
"Data": {
"jobId": "b3f1c2d4-0000-0000-0000-000000000009",
"status": "completed",
"pool": "AGU",
"poolPercentConsumed": 42,
"granted": true,
"rejectionReason": null
}
}
uip 平台用户充值可获得
检查充值授权作业的状态。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<job-id> | 是 | top-ups create 返回了充值作业 ID。 |
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。 |
示例
uip platform users top-ups get b3f1c2d4-0000-0000-0000-000000000009
uip platform users top-ups get b3f1c2d4-0000-0000-0000-000000000009
数据形状(--输出 json)
{
"Code": "TopUpStatus",
"Data": {
"jobId": "b3f1c2d4-0000-0000-0000-000000000009",
"status": "completed",
"granted": true,
"rejectionReason": null
}
}
{
"Code": "TopUpStatus",
"Data": {
"jobId": "b3f1c2d4-0000-0000-0000-000000000009",
"status": "completed",
"granted": true,
"rejectionReason": null
}
}
UIP 平台用户充值请求
为您自己(已登录的用户)请求充值。系统会通知组织的管理员 — 它不会直接授予任何权限。
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。 |
示例
uip platform users top-ups request
uip platform users top-ups request
数据形状(--输出 json)
{
"Code": "TopUpRequested",
"Data": {
"userId": "11111111-1111-1111-1111-111111111111",
"outcome": "NotificationSent",
"message": "Your administrators have been notified."
}
}
{
"Code": "TopUpRequested",
"Data": {
"userId": "11111111-1111-1111-1111-111111111111",
"outcome": "NotificationSent",
"message": "Your administrators have been notified."
}
}
非 NotificationSent 结果(例如 NotEligible 或 NoActiveDistribution)将作为故障与服务器消息一起返回。
UIP 平台用户使用情况
查看每个用户的许可证消耗量:每月池消耗百分比和充值电子包消耗百分比。
UIP 平台用户使用情况列表
列出组织中具有许可证使用情况的用户。
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--limit | 整数 | 默认页面大小 | 要返回的最大用户数。 |
--offset | 整数 | 0 | 要跳过的用户数。 |
--sort-by | 字段 | — | 按用户使用情况行的字段排序(例如 email、displayName)。 |
--sort-order | asc | desc | — |
--license-codes | 以空格分隔的代码 | — | 筛选拥有特定许可证捆绑包的用户(例如 RPADEVPRONU ATTUNU)。 |
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。 |
示例
uip platform users usage list
uip platform users usage list --limit 50 --offset 50 --sort-by email --sort-order asc --license-codes RPADEVPRONU ATTUNU
uip platform users usage list
uip platform users usage list --limit 50 --offset 50 --sort-by email --sort-order asc --license-codes RPADEVPRONU ATTUNU
数据形状(--输出 json)
{
"Code": "UserUsageList",
"Data": [
{
"userId": "11111111-1111-1111-1111-111111111111",
"email": "jane.doe@example.com",
"displayName": "Jane Doe",
"licenses": ["RPADEVPRONU"],
"strongestLicense": "RPADEVPRONU",
"monthlyPercentConsumed": 64,
"topUpWalletPercentConsumed": 20,
"topups": 2,
"status": "TopUp"
}
]
}
{
"Code": "UserUsageList",
"Data": [
{
"userId": "11111111-1111-1111-1111-111111111111",
"email": "jane.doe@example.com",
"displayName": "Jane Doe",
"licenses": ["RPADEVPRONU"],
"strongestLicense": "RPADEVPRONU",
"monthlyPercentConsumed": 64,
"topUpWalletPercentConsumed": 20,
"topups": 2,
"status": "TopUp"
}
]
}
当用户没有月度配额时,monthlyPercentConsumed 为 null(而不是 0)。status 为 MonthlyLimit、TopUp 和 PaidUnits 之一。
获取 UIP Platform 用户使用情况
显示每个用户的许可证消耗量:每种消耗性资源的每月消耗百分比、重置日期、每项服务的故障排除以及充值电子包(如有)。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
[user] | 否 | 用户标识符(名称或电子邮件前缀)。省略显示已登录用户的使用情况;传递一个路径 (管理员路径),以查看其他用户的。 |
选项
| 长 | 值 | 默认 | 描述 |
|---|---|---|---|
--organization | 帐户 ID | 会话默认值 | 组织帐户 GUID。 |
示例
uip platform users usage get
uip platform users usage get "jane.doe@example.com"
uip platform users usage get
uip platform users usage get "jane.doe@example.com"
数据形状(--输出 json)
{
"Code": "UserUsage",
"Data": {
"userId": "11111111-1111-1111-1111-111111111111",
"consumables": [
{
"entitlement": "AgenticPool",
"monthlyPercentConsumed": 64,
"resetsOn": "2026-08-01T00:00:00.000Z",
"services": [
{ "service": "AgentDevelopment", "serviceName": "Agent Development", "percentOfPool": 40 }
],
"topUpWallet": {
"monthlyPercentConsumed": 20,
"topups": 2,
"firstGrantedOn": "2026-07-10T09:00:00.000Z",
"services": [],
"topupCountPerMonth": [
{ "month": "2026-07-01T00:00:00.000Z", "topupCount": 2 }
]
}
}
]
}
}
{
"Code": "UserUsage",
"Data": {
"userId": "11111111-1111-1111-1111-111111111111",
"consumables": [
{
"entitlement": "AgenticPool",
"monthlyPercentConsumed": 64,
"resetsOn": "2026-08-01T00:00:00.000Z",
"services": [
{ "service": "AgentDevelopment", "serviceName": "Agent Development", "percentOfPool": 40 }
],
"topUpWallet": {
"monthlyPercentConsumed": 20,
"topups": 2,
"firstGrantedOn": "2026-07-10T09:00:00.000Z",
"services": [],
"topupCountPerMonth": [
{ "month": "2026-07-01T00:00:00.000Z", "topupCount": 2 }
]
}
}
]
}
}
退出代码
请参阅退出代码。没有动词特定的覆盖。
相关命令
uip platform groups— 一次将捆绑包租赁给许多用户的组规则(与source: "group"中的users licenses get一起显示)。uip platform tenants— 租户级别的运行时和消耗性分配。
另请参阅
- 全局选项。