Provide secure information to pipelines

Owned by Yaojie Feng
Last updated: Jun 03, 2021 by Sree Raman
2 min read

This page describes how to provide secure information, such as credentials and password, to Data Fusion pipelines. This can be done by using the secure store REST API.

Use secure information in pipelines

  1. In the Data Fusion UI, go to the System Admin link in the top right hand side corner. Select Configuration and go to Make HTTP Calls link.

  2. Make an HTTP call to create a secure key.

    You can now use the secure key name in the pipelines to retrieve the credentials.

  3. The Wrangler can use the secure key to retrieve the password by clicking on the shield button and select the corresponding secure key.

  4. The secure key can also be provided as a secure macro in the pipeline config. The secure macro has the format ${secure(<secure-key-name>)}.

Manage the secure information

In addition, the following REST calls can be used to manage the secure information:

  1. Save the secure information:

    PUT /namespaces/<namespace-id>/securekeys/<key-name>


    Where namespace-id is the namespace name, key-name is a key for your credentials. This key needs to be provided to pipelines to use the credentials. The call needs a JSON body with the format:

    { "description": "your description", "data": "your password", "properties": { "<property-key>": "<property-value>" } }

     

  2. Delete the secure information:

    DELETE /namespaces/<namespace-id>/securekeys/<key-name>