Organization Administration

Back Next

Configuring a connection to use the secrets manager

You can configure any connection that has sensitive credentials to retrieve these credentials from the secrets manager.

If you use a secrets manager, you need to create or edit connections in

Administrator

. You can't create and edit connections when you configure mappings and tasks in

Data Integration

Open the

Connections

page.

Perform either of the following actions:

To create a connection, click

New Connection

and enter the connection details.

To edit a connection, click the connection name, and then click

Edit

In the Connection Properties area, select

Use Secret Vault

Enable the checkbox next to each property that you store in the secrets manager, and then enter the path, including the secret name, in the corresponding field. If the secret is a JSON object, you'll also need to include the secret key.

The following table shows the value to enter based on the format of the secret:

Format of secret	Format of value to enter
JSON object, for example: { "engine": "mysql", "username": "tsmith", "password": "Hello123", "host": "my-database-endpoint.us-west-2.rds.amazonaws.com", "dbname": "myDatabase", "port": "1234" }	<secret_path>:<key>
Simple value, for example: --name "MyPassword" --value "Hello123"	<secret_path>

Format of secret

Format of value to enter

JSON object, for example:

{
    "engine": "mysql",
    "username": "tsmith",
    "password": "Hello123",
    "host": "my-database-endpoint.us-west-2.rds.amazonaws.com",
    "dbname": "myDatabase",
    "port": "1234"
}

<secret_path>:<key>

Simple value, for example:

--name "MyPassword" --value "Hello123"

<secret_path>

For example, you configure a relational connection and you store the database password in HashiCorp Vault. The path to the secret is secret/data/MyCredentials, and the secret key is MyPassword. To retrieve the password from HashiCorp Vault, select

Use Secret Vault

, enable the checkbox next to the

Password

field, and enter

secret/data/MyCredentials:MyPassword

in the

Password

field.

The following image shows the connection details:

The image shows the connection details for a SQL Server connection.
In the SQL Server Connection properties area, the Use Secret Vault
checkbox is checked. The checkbox next to the Password field is also
checked and the Password field contains a series of dots.

Select the runtime environment to be used with the connection.

The runtime environment you select for the connection must contain a local Secure Agent that runs the SecretManagerApp service. The Hosted Agent, serverless agents, and cloud-hosted agents can’t connect to an external secrets manager.

Configure the connection-specific properties.

To test the connection, click

Test Connection

Click

Save

For more information about configuring connections, see

Connections

Secrets manager configuration

Download Guide

Watch

Comments

Communities

Knowledge Base

Success Portal

2 COMMENTS

Back Next

We’d like to hear from you! Log in to comment.

Coomar Das - October 22, 2024

Hi,

The documentation seems to be lacking the format for Hashicorp Vault in item 4 above.

I think it is

< secret path > : < secret key>

For e.g.: secret/data/hello:rsv1_pwd

Would you please verify and update the documentation?

There is no need to publish this comment.

Thank you.

Informatica Documentation Team - October 23, 2024

Hi Coomer,

Thanks for reaching out! We're currently verifying the format with our development and QA teams and will update the documentation with this information in an upcoming release.

Chad Kimmell - March 04, 2025

I am having a very difficult time determining what the values should be for Azure KeyVault. An example for the path to the secret would be good to show. The last comment on this documentation was in October of '24. When will this be updated?

Informatica Documentation Team - March 04, 2025

Hi Chad,

Thanks for reaching out! We're currently reviewing this with our engineering team and will update the documentation with examples for different secrets managers in an upcoming release.

Rename Saved Search

Table of Contents

Organization Administration

Organization Administration

Configuring a connection to use the secrets manager

Configuring a connection to use the secrets manager