API DocumentationProduct Documentation
Product Documentation

Shared Settings and Secrets

Suggest Edits

This page describes the shared settings and secrets features which enable you to provide a more secure means to store and reuse data. Users assigned to the Admin role have access to these features:

  • Shared settings - Enable you to share the same value in several places.
  • Secrets - Secrets remove hard-coded credentials from code and do not store credentials in the application. They replace stored credentials with a runtime call to the Secrets Manager web service; secrets retrieve credentials dynamically. You should consider using a secret if you want to specify connection details of a database or service, for example: server name, IP address, and port number.

Access the Shared Settings Page

To access the shared settings page:

  1. Sign in to the TDP as an admin.
  2. In the left navigation menu, select the hamburger menu icon.
  3. Choose Administration. Then, choose Shared Settings. The Shared Settings page appears.
1852

Shared Settings

There are several columns of information on this page.

Field NameDescription
NameLists the names of the shared settings.
ValueLists the value of the shared settings (unless it is a secret). Secrets indicate how many times they have been edited.
Last ModifiedIndicates when the shared item was last modified.
Last Modified ByIndicates which user last modified the shared setting.
UsagesIndicates whether the shared setting is currently being used as well as how many usages it has.

Secrets Management

Secrets are managed in the Shared Settings page.

Add a Secret

To add a secret, do the following.

  1. In the Shared settings window, select “Add Secrets”
  2. In the Add a New Secret window, enter the name and value. Then retype the value to confirm it and click add.

📘

NOTE

The secret name must consist of lower case alphanumeric characters, '-' or '.', must start and end with an alphanumeric character and cannot have two non-alphanumeric characters next to each other.

  1. The Secret appears in the list. The value is hidden by an icon of a lock, which indicates that it is a secret.

📘

NOTE

When you add a secret, it might take up to 60 seconds before it appears in other places in the TDP's user interface.

Edit a Secret

To edit a Secret, do the following.

  1. Click the three button menu to the right of the entry and select Edit.
  2. In the Edit Secrets Item window, enter a new value, retype it again to confirm it, then click Edit.

Delete a Secret

To delete a Secret, do the following.

  1. Click the three button menu to the right of the entry and select Remove.
  2. In the Delete Settings Item window, click Delete.

View Secret Usage

To see where a Secret is used, do the following.

  1. Click the usage link in the Usages column.
  2. The usages appear in the Secret Usages window.
  3. To go to the place where the Secret is used, click the hyperlink in the Secret Usages window.

View a History of Edits to the Secret

To view the history of edits made to a Secret, do the following.

  1. Click the “Edited x times” link in the Value column of the Secret you’d like to see edits for.
  2. The audit trail appears. For more information on how to use the Audit trail, see this topic.

Manage Shared Settings

Shared settings are managed in the Shared Settings page.

Add a Shared Setting

To add a Shared Setting, do the following.

  1. In the Shared Settings window, select “Add Shared Settings Item”
  2. In the Add a new Shared Settings item, enter the name and value then click add.

📘

NOTE

The shared setting must consist of lower-case alphanumeric characters, dashes (-), periods (.), or underscores (_). Shared settings must also start and end with an alphanumeric character, and cannot have two non-alphanumeric characters next to each other.

  1. The Shared Setting appears in the list.

📘

NOTE

When you add a shared setting, it might take up to 60 seconds before it appears in other places in the TDP's user interface.

Edit a Shared Setting

To edit a Shared Setting, do the following.

  1. Click the three-button menu to the right of the entry and select Edit.
  2. In the Edit Shared Settings Item window, enter a new value, then click Edit.

Delete a Shared Setting

To delete a Shared Setting, do the following.

  1. Click the three-button menu to the right of the entry and select Remove.
  2. In the Delete Settings Item window, click Delete.

View Shared Setting Usage

To see where a Shared Setting is used, do the following.

  1. Click the usage link in the Usages column.
  2. The usages appear in the Shared Setting Usages window.
  3. To go to the place where the Shared Setting is used, click the hyperlink in the Shared Setting Usages window.

View a History of Edits to the Shared Setting

To view the history of edits made to a Shared Setting, do the following.

  1. Click the “Edited x times” link in the Value column of the Shared Setting you’d like to see edits for.
  2. The audit trail appears. For more information on how to use the Audit trail, see this topic.

Updated about 1 year ago