Skip to main content

DNS service users

Service users allow applications and integrations to access your DigiCert®​​ DNS account. You can create service users, assign roles, generate API tokens, and disable or delete service users when their access is no longer needed.

The difference between users and service users

Users represent individuals who access your account. Service users represent applications, integrations, or automated processes that access your account through the API.

Both users and service users have assigned roles that define what they can access and do. Service users use API tokens to authenticate requests, allowing you to manage access for an integration independently of an individual user.

Explore the Service users page

To view service users in your account, go to Configuration > Access management and select the Service users tab.

The page displays the following information:

Column

Description

Name

The service user’s name. Select it to open their profile

Status

Whether the service user is active or disabled

Created

The date the service user was created

Last modified

The date the service user was last updated

Tokens

The number of API tokens associated with the service user

Roles

The roles assigned to the service user

Each service user’s actions menu provides options to view their profile, edit their roles, disable or enable their access, and delete them. You can also select multiple service users to disable or delete them in bulk.

Manage a service user

A service user’s profile contains their details, assigned roles, and API credentials. To open a profile, select the service user’s name on the Service users page or select View service user from their actions menu.

The Overview tab displays the creation date, last modified date, service user ID, and the username of the person who created the service user. The Roles and permissions section shows their assigned roles.

The API credentials tab lists the tokens used to authenticate the service user. For each token, you can view its name, masked value, status, creation date, last-used date, and expiry date.

API credentials for service users

API tokens allow applications and integrations to authenticate as a service user. To view and manage these tokens, open the service user’s profile and select the API credentials tab.

The tab displays the following information:

Column

Description

Name

The name of the API token

Token

A masked version of the token

Status

The token’s status

Created

The date the token was created

Last used

The date the token was last used

Expire

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

Creating a service user does not automatically generate an API token. Generate a token for the application or integration that will authenticate as that service user.

Generate an API token

  1. Open Configuration > Access management.

  2. Select the Service users tab.

  3. Select Generate API token.

  4. Enter a Name that identifies the token.

  5. Optionally, specify an End date. Leave it blank if the token should have no scheduled expiry.

  6. Optionally, add a Note describing the token’s purpose.

  7. Select Generate.

  8. Copy the token and store it securely, then select Continue.

The full token is shown only once. After you continue, only its masked value appears in the token list.

Disabling or deleting the service user invalidates all associated credentials. Applications and integrations using those credentials will no longer be able to authenticate.

Active and disabled service users

A service user’s status indicates whether they are enabled to authenticate.

Status

Meaning

Active

The service user can authenticate using valid API credentials and access resources according to their assigned roles

Disabled

The service user cannot authenticate

To disable a service user, select Disable service user from their actions menu and confirm the action. To disable multiple service users, select their checkboxes and select Disable.

Disabling a service user invalidates all associated credentials and prevents them from authenticating. Applications and integrations using those credentials will no longer be able to authenticate API requests.

A disabled service user remains available to view and manage. To enable them again, select Enable service user from their actions menu.

Roles and permissions for service users

Roles define which resources a service user can access and which actions they can perform. You assign one or more roles when creating a service user and can edit those assignments later.

Assigned roles appear on the Service users page and in the Roles and permissions section of the service user’s profile.

To change the assigned roles, select Edit roles from the service user’s actions menu, or select the edit icon beside Roles and permissions in their profile.

Choose roles that provide the permissions the application or integration needs. Review these assignments when its responsibilities change.

For descriptions of the system roles and their permission matrices, see DNS roles and permissions.

Create and delete a service user

  1. Open Configuration > Access management.

  2. Select the Service users tab.

  3. Select Create service user.

  4. Enter a name that identifies the application, integration, or purpose.

  5. Select one or more roles.

  6. Optionally, enter a comment to provide context for the audit log entry.

  7. Select Create.

To delete a service user, select Delete service user from their actions menu and confirm the deletion. To delete multiple service users, select their checkboxes and select Delete.

Deleting a service user invalidates all associated credentials and cannot be undone.

Audit comments for service users

When creating a service user, you can add an optional comment to provide context for the audit log entry.

Use the comment to explain why the service user is needed, identify the application or integration it supports, or reference a related change request. For example: Created for the deployment integration to update DNS records during releases.

Audit comments provide context for the service user’s creation. The optional Note field used when generating an API token provides context for that specific token.

Edit a service user's permissions

  1. Open Configuration > Access management.

  2. Select the Service users tab.

  3. Select Edit roles from the service user’s actions menu, or open its profile and select the edit icon beside Roles and permissions.

  4. Add or remove roles to match the application’s responsibilities.

  5. Save the changes.

  6. Review the resulting role assignments.