Technical Tip: How to modify licenses distribution per organization using an API call (Postman), for MSSP and standalone environment

[YehonatanA]

Description

This article describes how to add or remove collector licenses (Workstations, Servers, IoT) for a specific organization in MSSP/Standalone environments, using an API query. 

Scope

MSSP\Standalone environments, which can modify a hoster-level admin user for all organizations.

Solution

Managing licenses per organization can be done on the backend by creating a support ticket. 
Standalone and MSSP environments can manage the organization's license distribution using an API query called 'Update Organization'.

Below are the steps to modify an API console user and how to run the API query using Postman. 

1. Create a console admin user with the Rest API role:

Navigate to Hoster view-> Users tab-> +Add user -> Edit user details, including the following values:

Organization -> All Organizations.

Role -> Admin.

Advanced -> Check Rest API.

Once saved, log out of the console, and log in using the API user, and change the password when prompted. Then, confirm this user can log in to the console using the updated password.

Do not proceed with running the API call without performing this step, as it will result in an Authentication error response.

Once performed and confirmed, proceed to the next steps.

 

2. Download the API collection from YourOrganization.console.com/rest-ui
   example:
   https://<YourBaseURLHere>.console.ensilo.com/rest-ui

   
   

3. Import the collection into Postman:
   
   
   

4. Browse to Query:

API -> Management REST -> Update Organization -> PUT Update Organization.

Then, edit the organization name and user authorization (Basic Auth).

 

 

5. Edit the query body by inserting the license number to be updated:

workstationsAllocated  -> Workstation license.

serversAllocated –> Servers License.

iotAllocated –> IoT license.

Note: Keep only the relevant rows in the query body to minimize syntax errors, delete all other parameters as in the following example:

Default query (full details):

 

Modified query to add workstations, servers, and IoT licenses:

Query results, adding Workstations, Servers, and IoT licenses, with response: 200OK:

5 licenses added for Workstations, Servers, and IoT, per the query body: