Attribuer des licences à un groupe avec quota

Point de terminaison d'API pour l'affectation de licences à un groupe avec des quotas de consommation facultatifs dans Test Cloud, nécessitant l'étendue PM.License.Write.

En tant qu'administrateur de l'organisation, utilisez ce point de terminaison pour attribuer des licences à un groupe et éventuellement configurer des quotas afin de limiter la consommation de licences. Nécessite une application externe avec l'étendue PM.License.Write.

Point de terminaison de l’API

PUT {accessURL}/{organizationName}/lease_/api/account/{accountId}/user-license/group/{groupId}/with-quota

Remplacez {accessURL} dans tous les chemins de point de terminaison par l'URL de base de votre plate-forme cloud :

Cloud Platform	URL d'accès
Test Cloud	https://cloud.uipath.com/
Test Cloud Secteur Public	https://govcloud.uipath.us/
Test Cloud dédié	https://{customURL}.dedicated.uipath.com/

En-têtes de requête.

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

Paramètres de chemin d'accès

Paramètre du chemin d'accès	Type de données	Description
accountId (requis)	GUID	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

{
    "userBundleCodes": ["string"],
    "quotas": [
        {
            "userBundleCode": "string",
            "limit": 10
        }
    ]
}

Remarque :

• userBundleCodes: tableau des codes de licence à attribuer.
• quotas (facultatif) : configurations de quota. Chaque userBundleCode dans les quotas doit exister dans le tableau userBundleCodes .
• Le quota limit doit être au moins de 1 et ne peut être inférieur à l’utilisation actuelle.
• Si les quotas sont vides, les licences sont attribuées sans limites.

Réponses

200 OK

Renvoie les licences de groupe allouées avec des quotas configurés et une utilisation actuelle.

404

L’organisation ou le groupe n’existe pas.

Exemple de requête

La requête doit ressembler à l'exemple suivant (cURL) :

curl --location --request PUT 'https://https://cloud.uipath.com/{organizationName}/lease_/api/account/1234/user-license/group/group-01/with-quota' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userBundleCodes": ["RPADEVPRONU", "IDU"],
    "quotas": [
        {
            "userBundleCode": "RPADEVPRONU",
            "limit": 10
        }
    ]
}'

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

{
  "groupRule": {
    "groupId": "group-01",
    "organizationId": "1234",
    "userBundleCodes": ["RPADEVPRONU", "IDU"]
  },
  "quotas": [
    {
      "userBundleCode": "RPADEVPRONU",
      "limit": 10,
      "currentUsage": 3
    }
  ]
}