API Users

Available beginning with Portal version 2.0.1.

API Users allows administrators to create their own API authentication tokens and apply specific roles to the tokens. This makes it possible for more automation and interaction with the ThreatLocker modules from outside of the ThreatLocker portal. Specifying roles that limit permissions to the tokens helps ensure that the tokens can't be misused to authenticate to APIs that are not permitted. 

Before you create an API User, you will need to have Admistrator Roles created. For assistance with creating User Roles, please see User Permissions | ThreatLocker Help Center (kb.help).

Creating API Users

Navigate to the Administrators page and select the API Users tab.

Select the blue 'New API User' button in the top left corner.

The Create API User sidebar will slide out from the right.

In the API Token Name input box, provide a name for this token. 

Select the 'Generate API Token' button to generate a token.  This token will only be visible until the sidebar is closed, so be sure to copy and save this token securely before closing the sidebar.

Select an API Token Expiration. The token will renew the selected expiration time each time it is used. So, if 365 days is selected, the token will expire after 365 days of not being used.  

In the Roles/Permissions section, you will specify the Roles and Organizations this token can be used for.

Select a Role in the 'Role' dropdown, and an Organization in the 'Organization' dropdown, then press the blue '+' button to add the specified Role/Organization combination to the list.

The Role name will be listed first with the Organization name in parentheses. 

Continue adding Roles and Organizations to provide this token with the permissions needed for the desired use case. Then press the blue 'Create' button.

This API User will now be listed on the main grid.

Main Grid

1. Multiselect box - provides a method to select multiple API Users at once and delete them in bulk.
2. API Token Name - displays the name of all current tokens
3. Created - displays the date/time the API User Token was created
4. Last Used - displays the date/time the API User Token was used
5. Actions - displays the quick action icons
   • Reset API Key - opens the sidebar to regenerate a new authentication token

• • Delete - deletes the API User on the same line

Locating API Documentation

From any page in the portal, select the 'Help' button in the top right-hand corner and then select the 'API Documentation' menu item.

This will link to the ThreatLocker public Swagger page which contains all publicly available APIs. Currently, this is limited to the Computers page. The available API documentation will be increased in the coming months, and will be announced in our Release Notes.