Allocate Licenses to a Group with Quota

As an organization admin, use this endpoint to allocate licenses to a group and optionally configure quotas to limit license consumption. Requires an external application with the scope PM.License.Write.

Point de terminaison de l’API

PUT <https://https://cloud.uipath.com/{organizationName}/lease_/api/account/{accountId}/user-license/group/{groupId}/with-quota>

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: Array of license codes to allocate (refer to user license codes).
• quotas (optional): Quota configurations. Each userBundleCode in quotas must exist in the userBundleCodes array.
• Quota limit must be at least 1 and cannot be lower than current usage.
• If quotas are empty, licenses are allocated without limits.

Réponses

200 OK

Returns the allocated group licenses with configured quotas and current usage.

404

Organization or group does not exist.

Exemple de requête

The request should resemble the following example (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
    }
  ]
}