- Démarrage
- Authentification
- Étendues et autorisations
- API de gestion de plate-forme
- Codes de produit de licence
- Attribuer des licences à une organisation
- Attribuer des licences à un locataire
- Attribuer des licences à un groupe
- Attribuer des licences à un utilisateur
Attribuer des licences à un utilisateur
En tant qu'administrateur de l'organisation, utilisez ce point de terminaison pour attribuer des licences à un utilisateur, en fonction de l'ID utilisateur.
Point de terminaison de l’API
PUT https://{yourDomain}/lease_/api/account/{accountId}/user-license
En-têtes de requête.
--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.
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 utilisateur. |
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.
{
"userIds": ["string"],
"userBundleCodes": ["string"],
"useExternalLicense": true
}
{
"userIds": ["string"],
"userBundleCodes": ["string"],
"useExternalLicense": true
}
- To see the available user bundle codes you may use in the request body, check out the user license codes.
- Vous pouvez allouer autant de licences que l'organisation en a achetées.
- Chaque utilisateur consomme une unité de licence.
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.
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://{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 - Trois utilisateurs ont besoin de licences :
- Utilisateur 1 avec
userId=singer-77 - Utilisateur 2 avec
userId=singer-88 - Utilisateur 3 avec
userId=singer-111
- Utilisateur 1 avec
- Vous souhaitez allouer les licences utilisateur suivantes :
- RPA Developer - Named user (the license code is
RPADEVNU) - Attended - Named user (the license code is
ATTUNU) - Tester - Named user (the license code is
TSTNU)
- RPA Developer - Named user (the license code is
L’appel doit ressembler à l’exemple suivant (cURL) :
curl --location --request POST 'https://https://{yourDomain}/{organizationName}/lease_/api/account/1234/user-license' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"userIds": ["singer-77", "singer-88", "singer-111"]
"userBundleCodes": ["RPADEVNU", "ATTUNU", "TSTNU"],
"useExternalLicense": true
}
curl --location --request POST 'https://https://{yourDomain}/{organizationName}/lease_/api/account/1234/user-license' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"userIds": ["singer-77", "singer-88", "singer-111"]
"userBundleCodes": ["RPADEVNU", "ATTUNU", "TSTNU"],
"useExternalLicense": true
}
Voici le corps de la réponse pour une allocation de licence réussie :
[
{
"userId": "string",
"organizationId": "string",
"useExternalLicense": true,
"userBundleCodes": [
"string"
]
}
]
[
{
"userId": "string",
"organizationId": "string",
"useExternalLicense": true,
"userBundleCodes": [
"string"
]
}
]