Attribuer des licences à un locataire

Référence de l'API pour l'affectation de licences à un locataire dans Test Cloud privé, y compris les points de terminaison, les champs de demande et les réponses.

En tant qu'administrateur hôte, utilisez ce point de terminaison pour attribuer des licences à un locataire, en fonction de l'ID du locataire.

Important :

Pour allouer des licences aux organisations et aux locataires, vous devez vous authentifier à l'aide des informations d'identification de l'hôte.

Point de terminaison de l’API

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

Remarque :

Pour allouer des licences à chaque service activé du locataire, vous devez effectuer un appel d'API distinct pour chaque service.

En-têtes de requête.

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

Remarque :

Pour obtenir le {access_token}, assurez-vous de vous authentifier via la méthode ROPC décrite dans l' authentification ROPC.

Paramètres de chemin d'accès

Paramètre du chemin d'accès	Type de données	Description
accountId (requis)	Chaîne de caractères (string)	L'ID de l'organisation dans laquelle réside votre locataire.
serviceScopeId (requis)	Chaîne de caractères (string)	L'ID du locataire auquel vous souhaitez attribuer des licences.
serviceType (requis)	Chaîne de caractères (string)	Le type de service.

Corps de la requête

Le corps de la requête contient le tableau des codes de licence de divers produits et leur quantité correspondante.

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

Remarque :

• Pour voir les codes de licence disponibles que vous pouvez utiliser dans le corps de la demande, consultez Codes de licence.
• Vous pouvez allouer autant de licences que l'organisation en a achetées.

Réponses

200 OK

Renvoie les licences allouées.

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

Aucune licence de compte n'est attribuée pour l'organisation indiquée.

409

L'attribution de licence n'est pas autorisée, car elle dépasse les quantités de licences du compte.

Exemple de requête

Supposons que vous ayez rassemblé toutes les informations nécessaires pour créer l'appel d'API.

• Votre {baseURL} est : https://tom-jones-server.com
• Votre {access_token} est : 1234 (pour des considérations de longueur).
• Le {accountId} du locataire qui a besoin d'une allocation de licence est : y-y-y-delilah
• Le {serviceScopeId} est : y1968. Le service Document Understanding est activé pour le locataire.
• Vous souhaitez allouer des licences de produit à l'organisation comme suit :
  • 5 Unattended Robots (le code de licence est UNATT)
  • 4 NonProduction Robots (le code de licence est NONPR)
  • 2 TIE Document Understanding

L’appel doit ressembler à l’exemple suivant (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 }      
        ]
}'

Voici le corps de la réponse pour une allocation de licence réussie :

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