- Primeros pasos
- Autenticación
- Ámbitos y permisos
- API de gestión de plataformas
- Licencias de códigos de producto
- Asignar licencias a una organización
- Asignar licencias a un tenant
- Asignar licencias a un grupo
- Asignar licencias a un usuario
Asignar licencias a una organización
Como administrador de host, puedes usar el punto final para asignar licencias a una organización en función del ID de la organización.
Para asignar licencias a organizaciones y tenants, debes autenticarte con las credenciales del host.
Punto final de API
PUT https://{yourDomain}/lrm/api/host/{hostAccountID}/organization/{organizationId}/license
Solicitar encabezados.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
To obtain the {access_token}, make sure to authenticate through the ROPC method described here.
Parámetros de ruta
| Parámetros de ruta | Tipo de datos | Descripción |
|---|---|---|
hostAccountID(obligatorio) | Cadena | El ID de la cuenta de host que asigna las licencias. Utiliza siempre el valor predeterminado: feb0dd79-85b6-483b-b297-0e49a1aa5b7d |
organizationId(obligatorio) | Cadena | El ID de la organización a la que desea asignar licencias. |
Solicitar cuerpo
El cuerpo de la solicitud contiene la matriz de códigos de licencia para varios productos y su cantidad correspondiente.
{
"productQuantities":
[
{ "code": "string", "quantity": 0 }
]
}
{
"productQuantities":
[
{ "code": "string", "quantity": 0 }
]
}
- To see the available license codes you may use in the request body, check out License codes.
- Puede asignar tantas licencias como haya adquirido la organización.
Respuesta
200 OK
Devuelve las licencias asignadas.
404
La licencia de host no existe o el marcador de característica para los flujos locales está desactivado.
409
La asignación de licencia no está permitida porque supera la cantidad de licencias de host.
Solicitud de ejemplo
Supongamos que has recopilado toda la información necesaria para crear la llamada a la API.
- Tu
{baseURL}es:https://tom-jones-server.com - Tu
{access_token}es:1234(para consideraciones de longitud) - Tu
{hostAccountId}es:j0ne5 - El
{organizationId}que necesita asignación de licencia es:y-y-y-delilah - Desea asignar licencias de productos a la organización de la siguiente manera:
- 2 Unattended Robots (the license code is
UNATT) - 1 AI Center Pro license (the license code is
AIG) - 3 Testing licenses (the license code is
TAUNATT)
- 2 Unattended Robots (the license code is
La llamada debe parecerse al siguiente ejemplo (cURL):
curl --location --request POST 'https://tom-jones-server.com/lrm/api/host/j0ne5/organization/y-y-y-delilah/license' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"productQuantities":
[
{ "code": "UNATT", "quantity": 2 },
{ "code": "AIG", "quantity": 1 },
{ "code": "TAUNATT", "quantity": 3 }
]
}'
curl --location --request POST 'https://tom-jones-server.com/lrm/api/host/j0ne5/organization/y-y-y-delilah/license' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"productQuantities":
[
{ "code": "UNATT", "quantity": 2 },
{ "code": "AIG", "quantity": 1 },
{ "code": "TAUNATT", "quantity": 3 }
]
}'
Este es el cuerpo de respuesta para una asignación de licencia exitosa:
{
"accountId": "y-y-y-delilah",
"bundleCode": "string",
"endDate": 0,
"gracePeriod": 0,
"licenseCode": "string",
"licenseStatus": "string",
"products": [
{
"code": "string",
"quantity": 0,
"type": "string",
"features": [
{
"code": "string",
"type": "string",
"value": "string"
}
]
}
],
"templates": [
{
"productCode": "string",
"products": [
{
"code": "string",
"type": "string"
}
]
}
],
"startDate": 0,
"subscriptionCode": "string",
"subscriptionPlan": "string",
"payload": "string",
"type": "string",
"parentLicenseCode": "string"
}
{
"accountId": "y-y-y-delilah",
"bundleCode": "string",
"endDate": 0,
"gracePeriod": 0,
"licenseCode": "string",
"licenseStatus": "string",
"products": [
{
"code": "string",
"quantity": 0,
"type": "string",
"features": [
{
"code": "string",
"type": "string",
"value": "string"
}
]
}
],
"templates": [
{
"productCode": "string",
"products": [
{
"code": "string",
"type": "string"
}
]
}
],
"startDate": 0,
"subscriptionCode": "string",
"subscriptionPlan": "string",
"payload": "string",
"type": "string",
"parentLicenseCode": "string"
}