Open

You will learn

How to create Global User API Keys for users.

Prerequisites

Audience: IT Professional or End User
Difficulty: Basic
Time needed: Approximately 5 minutes
Tools required: N/A

API Keys

Similar in function to the individual API keys users can generate in the Manage Users page, ThreadFix allows for the global generation of API keys. The API key provides authentication when a user is working with ThreadFix from the command-line and in other instances where the ThreadFix API is accessed, such as any plug-ins that require API access. The system uses the user’s assigned roles to authorize actions for the key. On this page, ThreadFix displays API keys that created per-user as well as API keys without assigned users.

1. To create a new API Key, click on Global from the Navigation sidebar, then click on Administration and select the API Keys page.
   
   

2. To create a new API key for a user, click the Add New Key button.
   
   

   Open

   

    

3. This brings up the modal dialog for key creation. Type in a few letters of the user’s name, and a drop-down list appears of all users whose username contains those characters. Select the desired user, optionally add any notes about the key, and click the Create Key button.
   
   

    

4. ThreadFix displays a success banner including the API Key at the top of the interface. If a registered user was entered, the key will automatically use the named user’s roles to authorize actions with this key.
   
   

Edit/Delete API Key

Using the Edit/Delete button, users can edit the API Key via the Edit Key modal or then use the Delete button to remove the key.

Note the key was delete as shown below.

Table of Contents