automation-suite
2023.4
false
- Introdução
- Autenticação
- Escopos e permissões
- APIs de gestão de plataforma
Como alocar licenças a um tenant
Importante :
A tradução automática foi aplicada parcialmente neste conteúdo.
Guia da API do Automation Suite
Last updated 11 de nov de 2024
Como alocar licenças a um tenant
Como administrador de host, use este terminal para alocar licenças a um inquilino, com base na ID do inquilino.
Importante: Para alocar licenças para organizações e locatários, você precisa se autenticar usando as credenciais do host.
PUT
https://{yourDomain}/lrm/api/account/{accountId}/service-license/{serviceScopeId}/{serviceType}
Observação: para alocar licenças para cada serviço habilitado do locatário, você precisa fazer uma chamada de API separada para cada serviço.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Observação: para obter o
{access_token}
, certifique-se de se autenticar por meio do método ROPC, descrito aqui.
Parâmetro do caminho |
Tipo de dados |
Description |
---|---|---|
(obrigatório) |
String |
A ID da organização na qual seu locatário reside. |
(obrigatório) |
String |
A ID do tenant ao qual você deseja alocar licenças. |
(obrigatório) |
String |
O tipo de serviço. |
O corpo da solicitação contém a matriz de códigos de licença para vários produtos e sua quantidade correspondente.
{
"tenantName": "string",
"products":
[
{ "code": "string", "quantity": 0 }
]
}
{
"tenantName": "string",
"products":
[
{ "code": "string", "quantity": 0 }
]
}
Observação:
- Para ver os códigos de licenças disponíveis que você pode usar no corpo da solicitação, verifique Códigos de licenças.
- Você pode alocar quantas licenças a organização comprou.
Retorna as licenças de serviços alocadas.
{
"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"
}
Digamos que você reuniu todas as informações necessárias para criar a chamada de API.
- Seu
{baseURL}
é:https://tom-jones-server.com
- Seu
{access_token}
é:1234
(para considerações de comprimento). - O
{accountId}
do locatário que precisa de alocação de licença é:y-y-y-delilah
- O
{serviceScopeId}
é:y1968
. O inquilino tem o serviço Document Understanding habilitado. - Você deseja alocar licenças de produto para a organização acima da seguinte forma:
- 5 Unattended Robots (o código da licença é
UNATT
) - 4 Robôs NonProduction (o código da licença é
NONPR
) - 2 licenças do Document Understanding (o código da licença é
TIE
)
- 5 Unattended Robots (o código da licença é
A chamada deve ter a seguinte aparência (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 }
]
}'
Aqui está o corpo da resposta para uma alocação de licença bem-sucedida:
{
"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"
}