Attribuer des licences à un groupe

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

En tant qu'administrateur de l'organisation, utilisez ce point de terminaison pour attribuer des licences à un groupe. Pour ce faire, vous devez créer une application externe avec l'étendue PM.License.Write.

Découvrez comment créer une application externe.

Point de terminaison de l’API

PUT https://{yourDomain}/{organizationName}/lease_/api/account/{accountId}/user-license/group/{groupId}

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 Méthodes d'authentification.

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.
groupId (requis)	Chaîne de caractères (string)	L'ID du groupe auquel vous souhaitez attribuer des licences. Vous pouvez récupérer cet ID en suivant ces étapes.

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.

{
    "userBundleCodes": ["string"]
}

Remarque :

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

Réponses

200 OK

Renvoie les licences de groupe allouées.

404

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

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://{yourDomain}/{organizationName}.
• Votre {access_token} est : 1234 (pour des considérations de longueur).
• Le {accountId} du locataire qui a besoin d'une allocation de licence est : song-one
• Le {groupId} est : group-01.
• Vous souhaitez attribuer des licences utilisateur au groupe comme suit :
  • Automation Developers RPADEVPRONU Named User
  • Concepteur Insights (le code de licence est IDU)
  • CTZDEVCU Developer - Multiuser

L’appel doit ressembler à l’exemple suivant (cURL) :

curl --location --request POST 'https://https://{yourDomain}/{organizationName}/lease_/api/account/1234/user-license/group/group-01' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userBundleCodes": ["RPADEVPRONU", "IDU", "CTZDEVCU"], 
    "useExternalLicense": false
}'

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

{
  "groupId": "string",
  "organizationId": "string",
  "useExternalLicense": false,
  "userBundleCodes": [
    "string"
  ]
}