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.

API-Endpunkt

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

Anforderungsheader

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

Pfadparameter

Pfadparameter	Datentyp	Beschreibung
accountId (erforderlich)	GUID	Die ID der Organisation, in der sich Ihr Mandant befindet.
groupId (erforderlich)	String	Die ID der Gruppe, der Sie Lizenzen zuweisen möchten. Sie können diese ID abrufen, indem Sie die folgenden Schritte ausführen.

Anforderungstext

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

Hinweis:

• 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.

Antworten

200 OK

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

404

Organization or group does not exist.

Beispielanforderung

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
        }
    ]
}'

Hier ist der Antworttext für eine erfolgreiche Lizenzzuweisung:

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