> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.deepmask.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Manage secrets

> Add connector credentials to the Vault, choose who can use them, and edit, replace, disable, or delete them without exposing the secret.

Once the Vault is open, you can add secrets, decide who can use them, and keep them up to date. Every change is reviewed before it is applied, recorded in the Vault history, and emailed to all admins in your organization.

> [!NOTE]
>
> You need an open Vault to make changes. If you haven't opened it yet, see [Open the Vault](https://documentation.deepmask.io/vault/open-the-vault.md).

## The secrets list

The Vault has two tabs:

* **Secrets** lists every secret with its connector, type, status, the number of connected members, when it was last used, and who last updated it. Use the search box and **Filter and sort** to filter by connector, status, or credential type.
* **History** lists every change and every Vault unlock in your organization.

Select a secret to open its details.

## Add a secret

**1. Start a new secret**

Select **Add secret**.

**2. Choose a type**

Choose **App credentials** to store credentials for a connector, or **Shared secret** to store a set of key–value pairs that belongs to no connector.

**3. Choose a connector**

For app credentials, select the connector you want to configure for your organization. The connector page shows a **Setup guide** link, the requested scopes, and — for Microsoft — a link to review admin consent.

**4. Name and describe it**

Enter a **Connection name** and, optionally, a **Description**. Members see the name when they choose an organization connection, so use one that helps them pick the right account or environment, such as "Salesforce EU production".

**5. Enter the credentials**

Fill in the credential fields for that connector (see the table below). Secrets are never shown again after saving, so double-check them.

**6. Save**

Select **Save**. The secret is available right away to everyone in the organization. To limit it, [change who can use it](#choose-who-can-use-a-secret).

### Credentials by connector

| Connector | What you enter | Notes |
| - | - | - |
| Salesforce (Enterprise) | Consumer Key (Client ID) and Consumer Secret of your Salesforce connected app | The instance URL is discovered when each member signs in. See [Salesforce setup](https://documentation.deepmask.io/salesforce.md). |
| Microsoft (Enterprise) | Client ID and Tenant ID of your Microsoft Entra app | No client secret is needed. An Entra admin may need to grant consent. See [Microsoft Enterprise setup](https://documentation.deepmask.io/msft-enterprise.md). |
| Bright Data | API key | All members use the organization's key. |
| 2slides | API key | All members use the organization's key. |
| Custom MCP server | Server URL plus either an **API Key**, or a consumer key and optional secret (**Key & Secret**) | Choose the option under **Authentication**. The URL must be a public `http` or `https` address. |
| Shared secret | Up to 20 key–value pairs, for example a client ID and client secret | Not used by any connector yet. Kept for upcoming workflows, automations, and agents. |

> [!NOTE]
>
> For now, you can add one secret per connector. Custom MCP servers are the exception: add one secret per server, for as many servers as you need. Names must be unique within your organization and can be up to 80 characters long.

## Secret details

Selecting a secret opens its details in three tabs.

> [tab] Overview
>
> * **Configuration** shows the connector and field names. Secret values always appear masked.
> * **Access** shows who can use the secret, with **Manage access** to change it.
> * **Availability** lets you disable or enable the secret.
> * **Danger zone** lets you delete the secret.

> [tab] Usage
>
> Shows how many members are connected, how many connections use the secret, and when it was last used successfully. The **Members** table lists each connected member with a status of **Connected** or **Reconnect required**, and the last error if one occurred.
>
> Shared secrets have no Usage tab because nothing uses them yet.

> [tab] History
>
> Lists every change made to this secret: who made it, when, and what changed.

## Review and confirm changes

When you edit, replace, restrict, disable, or delete a secret, DeepMask first shows a review of the change and its consequences — for example, how many connected members will have to reconnect. Select **Review change**, check the summary, and confirm. You don't need to enter another code while the Vault is open.

If another admin changes the same secret at the same moment, your change is refused instead of overwriting theirs. Refresh the secret and try again.

## Edit a secret

Select **Edit secret** to change the name or description. This doesn't affect connected members.

## Replace credentials

Use **Replace credentials** when you rotate a client secret or API key, or move to a different app.

**1. Open the secret**

Select the secret and choose **Replace credentials**.

**2. Enter the new values**

Enter the complete new credentials. Fields marked **Optional · leave empty to keep current** keep their stored value when left empty.

**3. Review the impact**

The review shows whether connected members will need to reconnect, then apply the change.

Whether members need to reconnect depends on what changed:

| Change | Effect on connected members |
| - | - |
| New Salesforce consumer secret, same consumer key | Connections keep working. |
| New API key for Bright Data, 2slides, or a Custom MCP server | Connections use the new key from their next use. |
| New client ID or consumer key, or a different Microsoft tenant | Members must reconnect. Their connector shows **Reconnect**. |

## Choose who can use a secret

By default, everyone in the organization can use a new secret. To limit it:

**1. Open access settings**

Open the secret and select **Manage access** in the **Access** section.

**2. Pick people or groups**

Choose **Everyone in the organisation**, or search for people and groups and select **Add**. A member of a listed group can use the secret while they belong to that group.

**3. Confirm**

Review the change and confirm.

Access rules apply to everyone, including admins. An admin who isn't on the list can still manage the secret but can't connect through it. A restricted secret with nobody on its list can't be used by anyone.

When a member loses access — because you removed them or they left a listed group — their connection stops at its next sign-in or token refresh, and their connector asks them to reconnect.

## Disable or enable a secret

Disabling a secret stops new use through DeepMask without deleting anything.

1. Open the secret and go to **Availability**.
2. Select **Disable**, review the change, and confirm.

Existing connections stop working at their next sign-in or token refresh. Members aren't offered a disabled secret when they add a connector. To make it available again, select **Enable**.

## Delete a secret

> [!WARNING]
>
> Deleting a secret can't be undone. The secret is destroyed immediately, and every member connected through it must reconnect — with another organization connection or their own credentials.

1. Open the secret and go to **Danger zone**.
2. Select **Delete** and confirm.

The secret's name and its history are kept for your records. Deleting a secret in DeepMask **doesn't revoke the credentials at the provider**. If you no longer need them, also revoke the client secret or API key in Salesforce, Microsoft Entra, Bright Data, 2slides, or your MCP server.

## Notifications and history

* After every applied change, every admin in your organization receives an email with a summary of what changed.
* The **History** tab of the Vault records each change, each unlock, each wrong code, and each lockout, with the admin who did it and when.

> [!TIP]
>
> If an email reports a change nobody on your team made, follow the steps in [Vault security](https://documentation.deepmask.io/vault/security.md#if-something-looks-wrong).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.