Get Org License Summary

Retrieves the license summary for your organization, including licensed and allocated robots, licensed and used user licenses, and licensed, allocated, and used consumables. Requires an external application with the scope PM.License.Read.

了解如何创建外部应用程序。

API 端点

GET {accessURL}/{organizationName}/license_/api/account/{accountId}/license-summary

将所有端点路径中的{accessURL}替换为您的云平台的基本 URL：

Cloud Platform	访问 URL
Automation Cloud	https://cloud.uipath.com/
Automation Cloud 公共部门	https://govcloud.uipath.us/
Automation Cloud 专用	https://{customURL}.dedicated.uipath.com/

请求标头

--header 'Authorization: Bearer {access_token}'

备注：

To obtain the {access_token}, make sure to authenticate through the Resource Owner Password Credentials (ROPC) method described on the Authentication Methods page.

路径参数

路径参数	数据类型	描述
accountId (必填)	Guid	The ID of the organization for which to retrieve the license summary.

响应

200 OK

Returns the license summary for the organization, split into three arrays:

• robots — for each robot type, the total licensed quantity (total) and the total allocated quantity (allocated). See Robots for the available codes.
• userLicenses — for each user license, the total licensed quantity (total) and the total used quantity (used). See User Licenses for the available codes.
• consumables — for each consumable unit, the total licensed quantity (total), the total allocated amount (allocated), the total used amount (used), and the validity period (startDate, endDate) as Unix timestamps in seconds. See Consumables for the available codes.

404

未为指定组织分配帐户许可证。

请求示例

请求应类似于以下示例 (cURL)：

curl --location --request GET 'https://cloud.uipath.com/{organizationName}/license_/api/account/1234/license-summary' \
--header 'Authorization: Bearer {access_token}'

Here's the response body for a successful license summary retrieval:

{
    "robots": [
        {
            "code": "APPTESTR",
            "total": 5,
            "allocated": 2
        },
        {
            "code": "NONPR",
            "total": 0,
            "allocated": 0
        },
        {
            "code": "TAUNATT",
            "total": 5,
            "allocated": 2
        },
        {
            "code": "UNATT",
            "total": 5,
            "allocated": 2
        },
        {
            "code": "UNATT-HOSTING",
            "total": 0,
            "allocated": 0
        }
    ],
    "userLicenses": [
        {
            "code": "PMBU",
            "total": 5,
            "used": 0
        },
        {
            "code": "PMD",
            "total": 10,
            "used": 3
        },
        {
            "code": "IDU",
            "total": 55,
            "used": 1
        },
        {
            "code": "TSTNU",
            "total": 5,
            "used": 2
        },
        {
            "code": "AXPNU",
            "total": 100,
            "used": 10
        },
        {
            "code": "ACNU",
            "total": 2,
            "used": 0
        },
        {
            "code": "RPADEVPROCU",
            "total": 15,
            "used": 0
        },
        {
            "code": "RPADEVPRONU",
            "total": 15000,
            "used": 10
        },
        {
            "code": "CBNU",
            "total": 5,
            "used": 0
        },
        {
            "code": "ATTUNU",
            "total": 5,
            "used": 1
        },
        {
            "code": "PRONU",
            "total": 200,
            "used": 12
        },
        {
            "code": "CTZDEVNU",
            "total": 5,
            "used": 0
        },
        {
            "code": "BASICNU",
            "total": 10,
            "used": 7
        },
        {
            "code": "AKIT",
            "total": 100,
            "used": 0
        },
        {
            "code": "PLUSNU",
            "total": 2,
            "used": 5
        }
    ],
    "consumables": [
        {
            "code": "AGU",
            "total": 995658,
            "allocated": 130,
            "used": 1,
            "startDate": 1707177600,
            "endDate": 2230847999
        },
        {
            "code": "APPU",
            "total": 0,
            "allocated": 0,
            "used": 0,
            "startDate": null,
            "endDate": null
        },
        {
            "code": "FCCU",
            "total": 0,
            "allocated": 0,
            "used": 0,
            "startDate": null,
            "endDate": null
        },
        {
            "code": "HEAL",
            "total": 303330,
            "allocated": 1500,
            "used": 0,
            "startDate": 1762128000,
            "endDate": 1920844799
        },
        {
            "code": "HEALTEST",
            "total": 0,
            "allocated": 0,
            "used": 0,
            "startDate": null,
            "endDate": null
        },
        {
            "code": "LU",
            "total": 0,
            "allocated": 0,
            "used": 0,
            "startDate": null,
            "endDate": null
        },
        {
            "code": "MRSU",
            "total": 0,
            "allocated": 0,
            "used": 0,
            "startDate": null,
            "endDate": null
        },
        {
            "code": "PLTU",
            "total": 0,
            "allocated": 0,
            "used": 0,
            "startDate": null,
            "endDate": null
        },
        {
            "code": "RU",
            "total": 0,
            "allocated": 0,
            "used": 0,
            "startDate": null,
            "endDate": null
        },
        {
            "code": "SPR",
            "total": 0,
            "allocated": 0,
            "used": 0,
            "startDate": null,
            "endDate": null
        },
        {
            "code": "TEU",
            "total": 0,
            "allocated": 0,
            "used": 0,
            "startDate": null,
            "endDate": null
        }
    ]
}