automation-suite
2024.10
true
- Getting started
- Authentication
- Scopes and permissions
- Platform Management APIs
Automation Suite API guide
Last updated Feb 24, 2025
As an organization admin, use this endpoint to allocate licenses to a user, based on the user ID.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'Note: To obtain the
{access_token}, make sure to authenticate through the ROPC method described here.
|
Path param |
Data type |
Description |
|---|---|---|
|
(required) |
String |
The ID of the organization in which your user resides. |
The request body contains the array of license codes for various products and their corresponding quantity.
{
"userIds": ["string"],
"userBundleCodes": ["string"],
"useExternalLicense": true
}{
"userIds": ["string"],
"userBundleCodes": ["string"],
"useExternalLicense": true
}Note:
- To see the available user bundle codes you may use in the request body, check out the user license codes.
- You may allocate as many licenses as the organization has purchased.
- Each user consumes a license unit.
200 OK
Returns the allocated group licenses.404
No account license is allocated for the indicated organization.
409
The license allocation is not allowed because it exceeds the account license quantities.
Let's say you gathered all the information needed to build the API call.
- Your
{baseURL}is:https://{yourDomain}//{organizationName}. - Your
{access_token}is:1234(for length considerations). - The
{accountId}of the tenant that needs license allocation is:song-one - You have three users that need licenses:
- User 1 with the
userId=singer-77 - User 2 with the
userId=singer-88 - User 3 with the
userId=singer-111
- User 1 with the
- You want to allocate the following user licences:
- 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
The call should resemble the following example (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
}Here's the response body for a successful license allocation:
[
{
"userId": "string",
"organizationId": "string",
"useExternalLicense": true,
"userBundleCodes": [
"string"
]
}
][
{
"userId": "string",
"organizationId": "string",
"useExternalLicense": true,
"userBundleCodes": [
"string"
]
}
]
