Asignar licencias a un tenant

Como administrador de host, usa este punto de conexión para asignar licencias a un tenant según el ID de tenant.

Importante:

Para asignar licencias a organizaciones y tenants, debes autenticarte con las credenciales del host.

Punto final de API

PUT https://{yourDomain}/lrm/api/account/{accountId}/service-license/{serviceScopeId}/{serviceType}

Nota:

Para asignar licencias a cada servicio habilitado del tenant, debes realizar una llamada a la API independiente para cada servicio.

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Nota:

Para obtener el {access_token}, asegúrate de autenticarte a través del método ROPC descrito aquí.

Parámetros de ruta

Parámetros de ruta	Tipo de datos	Descripción
accountId (obligatorio)	Cadena	El ID de la organización en la que reside su tenant.
serviceScopeId (obligatorio)	Cadena	El ID del tenant al que quieres asignar licencias.
serviceType (obligatorio)	Cadena	El tipo de servicio.

Solicitar cuerpo

El cuerpo de la solicitud contiene la matriz de códigos de licencia para varios productos y su cantidad correspondiente.

    {
      "tenantName": "string",
      "products": 
        [
          { "code": "string", "quantity": 0 } 
        ]
    }

Nota:

• Para ver los códigos de licencia disponibles que puedes utilizar en el cuerpo de la solicitud, consulta Códigos de licencia.
• Puede asignar tantas licencias como haya adquirido la organización.

Respuesta

200 OK

Devuelve las licencias de servicio asignadas.

{
  "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"
}

404

No se asigna ninguna licencia de cuenta para la organización indicada.

409

La asignación de licencias no está permitida porque supera las cantidades de licencias de la cuenta.

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)
• El {accountId} del tenant que necesita asignación de licencia es: y-y-y-delilah
• El {serviceScopeId} es: y1968. El tenant tiene habilitado el servicio Document Understand.
• Desea asignar licencias de productos a la organización de la siguiente manera:
  • 5 robots desatendidos (el código de licencia es UNATT)
  • 4 NonProduction Robots (el código de licencia es NONPR)
  • 2 licencias de Document Understanding (el código de licencia es TIE)

La llamada debe parecerse al siguiente ejemplo (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 }      
        ]
}'

Este es el cuerpo de respuesta para una asignación de licencia exitosa:

{
  "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"
}