automation-suite
2023.10
false
- 入门指南
- 身份验证
- 作用域和权限
- 平台管理 API
Automation Suite API 指南
Last updated 2024年11月11日
向租户分配许可证
作为主机管理员,请使用此端点根据租户 ID 向租户分配许可证。
重要提示: 要将许可证分配给组织和租户,您需要使用主机凭据进行身份验证。
PUT
https://{yourDomain}/lrm/api/account/{accountId}/service-license/{serviceScopeId}/{serviceType}
注意: 要将许可证分配给租户的每个已启用服务,您需要为每个服务进行单独的 API 调用。
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
路径参数 |
数据类型 |
描述 |
---|---|---|
(必填) |
字符串 |
租户所在组织的 ID。 |
(必填) |
字符串 |
要向其分配许可证的租户 ID。 |
(必填) |
字符串 |
服务类型。 |
请求正文包含各种产品的许可证代码数组及其相应的数量。
{
"tenantName": "string",
"products":
[
{ "code": "string", "quantity": 0 }
]
}
{
"tenantName": "string",
"products":
[
{ "code": "string", "quantity": 0 }
]
}
备注:
- 要查看可在请求正文中使用的许可证代码,请查看许可证代码。
- 您可以分配与组织购买的许可证一样多的许可证。
返回已分配的服务许可证。
{
"accountId": "string",
"serviceScopeId": "string",
"serviceType": "string",
"license": {
"licenseCode": "string",
"bundleCode": "string",
"subscriptionCode": "string",
"licenseStatus": "string",
"startDate": 0,
"endDate": 0,
"gracePeriod": 0,
"products": [
{
"code": "string",
"quantity": 0,
"type": "string",
"features": [
{
"code": "string",
"type": "string",
"value": "string"
}
]
}
],
"templates": [
{
"productCode": "string",
"products": [
{
"code": "string",
"type": "string"
}
]
}
],
"payload": "string",
"boonLicenseCode": "string"
},
"userLicensingEnabled": true,
"accountLicenseCode": "string"
}
{
"accountId": "string",
"serviceScopeId": "string",
"serviceType": "string",
"license": {
"licenseCode": "string",
"bundleCode": "string",
"subscriptionCode": "string",
"licenseStatus": "string",
"startDate": 0,
"endDate": 0,
"gracePeriod": 0,
"products": [
{
"code": "string",
"quantity": 0,
"type": "string",
"features": [
{
"code": "string",
"type": "string",
"value": "string"
}
]
}
],
"templates": [
{
"productCode": "string",
"products": [
{
"code": "string",
"type": "string"
}
]
}
],
"payload": "string",
"boonLicenseCode": "string"
},
"userLicensingEnabled": true,
"accountLicenseCode": "string"
}
假设您收集了构建 API 调用所需的所有信息。
- 您的
{baseURL}
为:https://tom-jones-server.com
- 您的
{access_token}
为:1234
(出于长度考虑)。 - 需要分配许可证的租户
{accountId}
为:y-y-y-delilah
-
{serviceScopeId}
为:y1968
。 租户已启用 Document Understanding 服务。 - 您希望将产品许可证分配给上述组织,如下所示:
调用应如下所示 (cURL):
curl --location --request POST 'https://tom-jones-server.com/lrm/api/account/y-y-y-delilah/service-license/y1968/?????' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"productQuantities":
[
{ "code": "UNATT", "quantity": 5 },
{ "code": "NONPR", "quantity": 4 },
{ "code": "TIE", "quantity": 2 }
]
}'
curl --location --request POST 'https://tom-jones-server.com/lrm/api/account/y-y-y-delilah/service-license/y1968/?????' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"productQuantities":
[
{ "code": "UNATT", "quantity": 5 },
{ "code": "NONPR", "quantity": 4 },
{ "code": "TIE", "quantity": 2 }
]
}'
以下是成功分配许可证的响应正文:
{
"accountId": "y-y-y-delilah",
"serviceScopeId": "y1968",
"serviceType": "string",
"license": {
"licenseCode": "string",
"bundleCode": "string",
"subscriptionCode": "string",
"licenseStatus": "string",
"startDate": 0,
"endDate": 0,
"gracePeriod": 0,
"products": [
{
"code": "string",
"quantity": 0,
"type": "string",
"features": [
{
"code": "string",
"type": "string",
"value": "string"
}
]
}
],
"templates": [
{
"productCode": "string",
"products": [
{
"code": "string",
"type": "string"
}
]
}
],
"payload": "string",
"boonLicenseCode": "string"
},
"userLicensingEnabled": true,
"accountLicenseCode": "string"
}
{
"accountId": "y-y-y-delilah",
"serviceScopeId": "y1968",
"serviceType": "string",
"license": {
"licenseCode": "string",
"bundleCode": "string",
"subscriptionCode": "string",
"licenseStatus": "string",
"startDate": 0,
"endDate": 0,
"gracePeriod": 0,
"products": [
{
"code": "string",
"quantity": 0,
"type": "string",
"features": [
{
"code": "string",
"type": "string",
"value": "string"
}
]
}
],
"templates": [
{
"productCode": "string",
"products": [
{
"code": "string",
"type": "string"
}
]
}
],
"payload": "string",
"boonLicenseCode": "string"
},
"userLicensingEnabled": true,
"accountLicenseCode": "string"
}