Attribuer des licences à une organisation

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

En tant qu'administrateur hôte, vous pouvez utiliser le point de terminaison pour allouer des licences à une organisation, en fonction de l'ID de l'organisation.

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/host/{hostAccountID}/organization/{organizationId}/license

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
hostAccountID (requis)	Chaîne de caractères (string)	L'ID du compte hôte qui alloue les licences. Utilisez toujours la valeur par défaut : feb0dd79-85b6-483b-b297-0e49a1aa5b7d
organizationId (requis)	Chaîne de caractères (string)	L'ID de l'organisation à laquelle vous souhaitez attribuer des licences.

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.

{
    "productQuantities": 
        [
          { "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.

404

La licence d'hôte n'existe pas ou l'indicateur de fonctionnalité pour les flux sur site est désactivé.

409

L'attribution de licences n'est pas autorisée, car elle dépasse les quantités de licences d'hôte.

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).
• Votre {hostAccountId} est : j0ne5
• Le {organizationId} qui nécessite une allocation de licence est : y-y-y-delilah
• Vous souhaitez allouer des licences de produit à l'organisation comme suit :
  • 2 Unattended Robots (le code de licence est UNATT)
  • 1 licence AI Center Pro (le code de licence est AIG)
  • 3 licences de test (le code de licence est TAUNATT)

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

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

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