Add KeyAdmin API Keys

The Secure Access Key Admin API enables you to create and manage Secure Access API keys. In a script or client program, use your KeyAdmin API key credentials to authenticate with Secure Access and generate a short-lived API access token. Then, make API requests with your access token to the Key Admin API to create Secure Access API keys for your organization. You must include your access token in an API request for every operation. For more information, see Secure Access API Authentication.

You can create any number of Key Admin API keys for your organization. When you create a KeyAdmin API key, choose a unique key name, description, key expiration date, and the KeyAdmin API key scopes. The key description and expiration date are optional. If you do not set an expiration date when you add the key, Secure Access sets your KeyAdmin API key to never expire.

Once you add a KeyAdmin API key to Secure Access, you can refresh your key's credentials, update the key's name, description, expiration date, and key scopes, and delete the API key.

Use Cases

• Programmatically create Secure Access API keys.
• Programmatically manage the Secure Access API keys in your organization—refresh API key credentials, update API key properties, or delete API keys.
• Write scripts or client programs that use KeyAdmin API keys to create and manage Secure Access API keys, and with your generated API keys, make requests to the Secure Access API. Integrate the client programs into your continuous integration or continuous delivery pipelines.

Table of Contents

• Prerequisites
• Add KeyAdmin API Key
• Refresh KeyAdmin API Key
• Update KeyAdmin API Key
• Delete KeyAdmin API Key

Prerequisites

• Full Admin user role. For more information, see Manage Accounts.

Add KeyAdmin API Key

1. Navigate to Admin > API Keys.

   

2. Click KeyAdmin Keys and then click Add.
   The number of expired API keys appears next to the red triangle. The number of API keys that expire within 30 days appears next to the yellow triangle.

3. Enter a name and description for the key. A name must contain less than 256 characters.
   The key description is optional.

4. Select the permissions for the key.

5. For Expiry Date, choose the expiration date for the key, or choose Never expire.

6. (Optional) For Network Restrictions, enter a comma-separated list of public IP addresses or CIDRs, then click Add.

   Note: You can add up to ten networks to your API key. You can only use your API key to authenticate requests for clients on the selected networks.

   

7. Click Create Key.

8. Copy and save your KeyAdmin Key and Key Secret.

9. Click Accept and Close.

Refresh KeyAdmin API Key

1. Navigate to Admin > API Keys.

2. Click KeyAdmin Keys, and then expand an API key.

   

3. Click Refresh Key.

4. Copy and save your KeyAdmin Key and Key Secret.
5. Click Accept and Close.

Update KeyAdmin API Key

You can modify one or multiple settings on your API key.

1. Navigate to Admin > API Keys.

2. Click KeyAdmin Keys, and then expand an API key.

   

3. Modify the KeyAdmin Key Name, Description, Permissions, and Expiry Date.

4. For Network Restrictions, update the list of IP addresses or CIDRs. Click on the X to remove a network address.

   

5. Click Save.

Delete KeyAdmin API Key

1. Navigate to Admin > API Keys.

2. Click KeyAdmin Keys, and then expand an API key.

   

3. Click Delete. In the dialog window, click Delete to remove the API key from your organization.

   

---

Add Secure Access API Keys < Add KeyAdmin API Keys > Manage Accounts