API key management
Overview
This guide provides step-by-step instructions for API key management, covering both targeted and comprehensive actions.
Targeted actions include:
Comprehensive actions include clearing multiple API keys and listing all available API keys.
Benefits
Managing API keys with DigiCert® DNS enhances security by preventing unauthorized access and reducing the risk of credential leakage through key rotation and expiration. Granular access controls ensure compliance with internal policies and external standards, supporting auditability, traceability, and visibility. By simplifying the entire key lifecycle, the platform improves operational efficiency and enables seamless integration with external systems.
Procedures
注意
This procedure clears all API keys generated by the user. Follow Path 1 if you are an administrator, or Path 2 if you are a standard user.
To test this function, call this API endpoint: POST /accessmanagement/api-key/bulk/delete
Path 1
Sign in to your DigiCert® DNS account.
From the landing page, go to the left sidebar and select Settings > Access Management.
In the API KEYS tab, select the checkboxes next to the API keys you want to delete.
Go to Actions > Delete API Key.
In the Confirm Deletion dialog, select Confirm.
A message appears confirming the successful clearance of the API keys.
Path 2
Sign in to your DigiCert® DNS account.
From the landing page, click the user icon in the top right corner and select My API Keys.
From the overflow menu (three vertical dots) at the end of the API key's row, select Delete Key.
In the Confirm Deletion dialog, select Confirm.
A message appears confirming the successful clearance of the API key.
Repeat Steps 3-4 as needed.
注意
This procedure deletes a specific API key (apikey1) created in an earlier procedure. Follow Path 1 if you are an administrator, or Path 2 if you are a standard user.
To test this function, call this API endpoint: DELETE /accessmanagement/api-key/{apiKeyId}
Path 1
Sign in to your DigiCert® DNS account.
From the landing page, go to the left sidebar and select Settings > Access Management.
In the API KEYS tab, select the checkbox of the API key you want to delete (for example, apikey1).
Go to Actions > Delete API Key.
Alternatively, select the overflow menu (three vertical dots) at the end of the API key's row, and select Delete Key.
In the Confirm Deletion dialog, select Confirm.
A message appears confirming the successful deletion of the API key.
Path 2
Sign in to your DigiCert® DNS account.
From the landing page, click the user icon in the top right corner and select My API Keys.
Locate the API key you want to delete (for example, apikey1).
From the overflow menu (three vertical dots) at the end of the API key's row, select Delete Key.
In the Confirm Deletion dialog, select Confirm.
A message appears confirming the successful deletion of the API key.
注意
This procedure generates two API keys: apikey1 and apikey2. These API keys are referenced in other procedures. Follow Path 1 if you are an administrator, or Path 2 if you are a standard user.
To test this function, call this API endpoint: POST /accessmanagement/api-key
Path 1
Sign in to your DigiCert® DNS account.
From the landing page, go to the left sidebar and select Settings > Access Management.
Select the USERS tab.
Select the user whose keys you want to manage.
Select the Generate API Key button.
In the Generate API Key dialog:
Enter a name for the key in the Name field (for example, apikey1).
Select an expiration option.
The default expiration date is set to one year from the current date.
(Optional) Add a note.
This can be viewed later by clicking the note icon next to the key.
Select Save to generate the API key.
In the API Key Generated - Action Required dialog:
Select Copy to copy the generated key.
Select Done to complete the process.
A message appears confirming the successful generation of the API key.
Repeat Steps 4-7 to create another API key, apikey2.
Path 2
Sign in to your DigiCert® DNS account.
From the landing page, click the user icon in the top right corner and select My API Keys.
Select the Generate API Key button.
A maximum of two API keys can exist at any given time.
In the Generate API Key dialog:
Enter a name for the key in the Name field (for example, apikey1).
Select an expiration option.
The default expiration date is set to one year from the current date.
(Optional) Add a note.
This can be viewed later by clicking the note icon next to the key.
Select Save to generate the API key.
In the API Key Generated - Action Required dialog:
Select Copy to copy the generated key.
Select Done to complete the process.
A message appears confirming the successful generation of the API key.
Repeat Steps 3-5 to create another API key, apikey2.
注意
This procedure displays all API keys generated by the user. Follow Path 1 if you are an administrator, or Path 2 if you are a standard user.
To test this function, call this API endpoint: GET /accessmanagement/api-key
Path 1
Sign in to your DigiCert® DNS account.
From the landing page, go to the left sidebar and select Settings > Access Management.
Select the API KEYS tab.
The table displays the API keys associated with all accounts.
Path 2
Sign in to your DigiCert® DNS account.
From the landing page, click the user icon in the top right corner and select My API Keys.
注意
This procedure displays the details of a specific API key (apikey1) created in an earlier procedure. Follow Path 1 if you are an administrator, or Path 2 if you are a standard user.
To test this function, call this API endpoint: GET /accessmanagement/api-key/{apiKeyId}
Path 1
Sign in to your DigiCert® DNS account.
From the landing page, go to the left sidebar and select Settings > Access Management.
Select the API KEYS tab.
The table displays the API keys associated with all accounts.
Locate the API key you want to view (for example, apikey1).
If needed, use Filters to quickly find a specific API key.
Select Columns at the top of the results table, then select all the checkboxes to ensure that all API key information is displayed.
Path 2
Sign in to your DigiCert® DNS account.
From the landing page, click the user icon in the top right corner and select My API Keys.
Locate the API key you want to view (for example, apikey1).
注意
This procedure rotates a specific API key (apikey1) intended for use in testing API endpoints. This key's value will be required to generate an authentication token and must not be shared. DigiCert® recommends storing it securely.
Follow Path 1 if you are an administrator, or Path 2 if you are a standard user.
To test this function, call this API endpoint: POST /accessmanagement/api-key/{apiKeyId}/rotate
Path 1
Sign in to your DigiCert® DNS account.
From the landing page, go to the left sidebar and select Settings > Access Management.
Select the API KEYS tab.
The table displays the API keys associated with all accounts.
Locate the API key you want to rotate (for example, apikey1).
If needed, use Filters to quickly find a specific API key.
Select the overflow menu (three vertical dots) at the end of the API key's row, and select Rotate Key.
In the Rotate API Key dialog:
(Optional) Modify the expiration option.
(Optional) Modify the note.
Select Save to rotate the API key.
In the API Key Rotated - Action Required dialog:
Select Copy to copy the rotated key.
Select Done to complete the process.
A message appears confirming the successful rotation of the API key.
Path 2
Sign in to your DigiCert® DNS account.
From the landing page, click the user icon in the top right corner and select My API Keys.
Locate the API key you want to rotate (for example, apikey1).
From the overflow menu (three vertical dots) at the end of the API key's row, select Rotate Key.
In the Rotate API Key dialog:
(Optional) Modify the expiration option.
(Optional) Modify the note.
Select Save to rotate the API key.
In the API Key Rotated - Action Required dialog:
Select Copy to copy the rotated key.
Select Done to complete the process.
A message appears confirming the successful rotation of the API key.
注意
The current version of DigiCert® DNS does not include a dedicated front-end tab for updating a specific API key. To complete this procedure, use the following endpoint:
PUT /accessmanagement/api-key/{apiKeyId}
For help configuring your testing environment, refer to the API guide.