Skip to main content

DNS API tokens

API tokens authenticate requests to DigiCert®​​ DNS as a user or service user. Generate tokens for applications and integrations, review their usage and expiry, and remove credentials when they are no longer needed.

Notice

Only Account owners and Account admins can generate and manage API tokens.

Token ownership and permissions

Each API token belongs to a user or service user. Requests authenticated with that token use the owning identity’s assigned permissions.

Use a user-associated token for requests made as an individual. For applications and automated processes, use a service user so you can manage their access independently of an individual’s account.

Permissions from multiple roles are combined. An action is allowed if any assigned role grants it. Adding a restrictive role does not reduce permissions granted by another role.

Before generating a token, review the identity’s roles and confirm that they match the intended tasks. See DNS roles and permissions.

Explore the API credentials page

To view a user’s tokens:

  1. Go to Configuration > Access management and select Users.

  2. Select the user’s username.

  3. Open API credentials.

To view a service user’s tokens:

  1. Go to Configuration > Access management and select Service users.

  2. Select the service user’s name.

  3. Open API credentials.

The tab displays the following information:

Column

Description

Name

The name identifying the token

Token

A masked version of the token

Status

The token’s status, such as Active or Revoked

Created

The date the token was created

Last used

The date the token was last used

Expires

The token’s expiry date, or Never if no expiry date is set

For user tokens, hover over the note icon to view any associated note.

Generate an API token

Before generating a token, confirm that you have opened the intended user or service user profile and reviewed its roles.

  1. Open the profile’s API credentials tab.

  2. Select Generate API token.

  3. Enter a Name identifying the token’s purpose.

  4. Optionally, specify an expiry using Expiry date. Leave the field blank if no scheduled expiry is required.

  5. Optionally, enter a Note describing the application or workflow that will use the token.

  6. Select Generate.

  7. Copy the full token and store it securely.

  8. Select Continue.

  9. Confirm that the token appears in the list with the intended expiry.

The full token is shown only once. After you continue, only its masked value appears. If you did not save the full value, generate a replacement token and remove the unused credential.

Creating a service user does not automatically generate a token. For the complete setup procedure, see Create a service user and API token.

Store and use tokens securely

Store tokens in a secure credential store and make them available only to the applications and people that need them. Keep full token values out of source code, shared documents, screenshots, and diagnostic logs.

Use descriptive names and notes to identify each token’s purpose. Review the owning identity’s roles alongside its credentials when an application’s responsibilities change.

For client configuration, see Set up Postman for the DNS API. Authentication specifications and request examples are provided in the DC: DigiCert® DNS API documentation.

Replace an API token

Replace a token when it is approaching expiry, its value may have been exposed, or your credential-management process requires rotation.

For a planned replacement:

  1. Open the owning identity’s API credentials tab.

  2. Generate a new token with a name and note identifying its purpose.

  3. Store the new value securely.

  4. Update each dependent application or integration to use the replacement.

  5. Verify that authentication and the required operations succeed.

  6. Revoke the previous token once all dependent applications have switched.

If a token may have been exposed, revoke it promptly and update affected applications with a replacement.

Revoke a token

The same controls are available for user and service user tokens.

Revoking a token prevents applications from using it to authenticate. The token remains listed with a Revoked status.

  1. Open the owning user’s or service user’s API credentials tab.

  2. Locate the intended token.

  3. Select Revoke token from its actions menu.

  4. Confirm the action.

  5. Verify that the status changes to Revoked.

To revoke multiple tokens, select their checkboxes and choose Revoke. Review the selected credentials before confirming.

Before revoking a credential, identify any applications that depend on it and arrange a replacement if they still require access.

Delete a token

The same controls are available for user and service user tokens.

Deleting a token removes it from the list and prevents applications from using it to authenticate. Deletion cannot be undone.

  1. Open the owning identity’s API credentials tab.

  2. Locate the intended token.

  3. Select Delete token from its actions menu.

  4. Confirm the action.

To delete multiple tokens, select their checkboxes and choose Delete. Review the selected credentials before confirming.

Before deleting a credential, identify any applications that depend on it and arrange a replacement if they still require access.

Service user status and credentials

Disabling or deleting a service user invalidates all associated credentials. Applications using those credentials can no longer authenticate API requests.

Disabling retains the service user’s profile for management. Deleting the service user cannot be undone. Review dependent applications and integrations before either action.

For identity management procedures, see DNS service users and DNS users.

Troubleshoot token access

If an API request fails:

  1. Confirm that the client uses the complete token value.

  2. Check the token’s status and expiry.

  3. Review the owning identity’s access status, particularly if it was recently changed.

  4. Review all assigned roles and verify that they permit the requested operation.

  5. Check that the token belongs to an identity in the intended account.

  6. Compare the client’s authentication configuration with the API documentation.

  7. Review the API response for further error details.

If you need help, see Contact us. Include your account details, the affected operation, the expected result, and the error response. Remove API tokens and other credentials before sharing request details.