License Vault API
The License Vault API offers a set of methods for accessing license usage data programmatically and automating license management. Here's what you can do via the API:
Get a list of all licenses allocated to a specific user.
Revoke a specific license or all licenses from a user.
Disconnect a specific product from License Vault.
Get a license usage report similar to the one you can export from the UI.
Get a denials report that helps you keep track of any license requests denied by License Vault.
Get the number of free and allocated licenses for each product you have in your License Vault.
For more information about the API methods, consult the API specification. You can access it from your License Vault by following the steps below.
To open the API specification
Log in to Toolbox Enterprise with administrator credentials.
In the top menu, select Licenses.
In the menu on the left, select Settings. Then scroll down to the License Vault API section and click the API specification link.
The link will take you to the Swagger-format specification.
Authorized access to the API
For authorized access to the API methods, you'll need to generate an access token that serves as a key to the License Vault data.
Once the token is generated, pass it to the Authorization parameter of your API requests. For example:
To generate an access token
Log in to Toolbox Enterprise with administrator credentials.
In the top menu, select Licenses.
In the menu on the left, select Settings. Then scroll down to the API access token section.
Click Generate token. If you don't see this button, colsult the relevant section below.
You will see a dialog with the access token displayed. Click Copy to copy your token to the clipboard, and be sure to save it in a secure location before closing the dialog.
What if I don't see the Generate token button?
If you see the Generate new token and Delete token buttons instead, you or another administrator has already generated an API access token for your License Vault.
We show the token only once to the administrator who generates it. If you don't have your token, contact other License Vault administrators in your company to obtain it or consider generating a new one.
Token security and lifetime
Each License Vault can have only one unique access token. All Toolbox Enterprise administrators can generate and delete it. Once the token is generated, it remains valid until one of the administrators deletes it or generates a new one.
Store your token in a secure location and don't share it with anyone unless you want them to have full access via the API to the license usage data stored in your License Vault.
Go to the API access token settings by following steps 1 and 2 from the instructions above.
Click Generate new token.
Click Generate new token in the dialog that pops up.
Copy and save the new token as described in step 4 of the instructions above.
Go to the API access token settings by following steps 1 and 2 from the instructions above.
Click Delete token.
Click Delete token in the dialog that pops up.