1. Introduction

Welcome to the Creating and Managing Secrets Guide!

This guide will assist in:

• Understanding the functionality and benefits of the Secrets Manager.
• Learning how to create, manage, and use secrets effectively.

Who is this guide designed for?
This guide is intended for users who need to manage sensitive data within the system.

Note: Ensure access to the Secrets Manager section in Account Settings is available before starting.

2. Overview

The Secrets Manager allows users to:

• Store credentials and other sensitive information in a centralized location.
• Use stored secrets in various parts of the system, such as Custom Code Nodes.
• Manage secrets by adding, updating, or deleting key-value pairs.

3. Getting Started

3.1 Prerequisites

Before beginning, ensure that:

• Access to the Secrets Manager section in Account Settings is available.
• The necessary permissions to create and manage secrets are granted.
• Familiarity with Custom Code Nodes is present, although it's not mandatory.

4. Step-by-Step Instructions

4.1 Navigation

To navigate to the Secrets Manager section:

1. Click on the Profile Icon.
2. Select Account Settings.
3. Choose Secrets Manager.

4.2 Creating a Secret

To create a new secret:

1. Click on +New Key.
2. Provide a unique Secret name.
3. Click on Add Item to add a Key-Value Pair.
4. Under Keyname, input the access name.
5. Under Keyvalue, input the access secret.
6. Repeat steps 3 to 5 to add more Key-Value Pairs to the Secret, if necessary.
7. Click on Create to finish creating the Secret.

4.3 Managing a Secret

To manage a secret:

1. From the Secrets listing table, locate the Secret to be managed.
2. Click on the Edit (pencil) icon.
3. Update the Key-Value Pair as required.
4. Click on Save to apply changes.

4.4 Using a Secret

To use a secret in a Custom Code Node:

1. Create a Custom Code Node.
2. While building a Custom Code Node, use the following snippet of code:

from meta.global_constants import get_secrets_data  
secret_json = get_secrets_data(f'{client_id}-{your-secret-name}')

Replace <your -secret-name> with the actual name of the Secret to be accessed.

Note: Now, any user in the organization (with relevant permissions) can use Secrets securely and efficiently.

5. Troubleshooting

Common Issues and Solutions

Problem 1: Unable to Access Secrets Manager

Cause: Lack of necessary permissions.
Solution:

1. Verify that the necessary permissions are granted.
2. Contact the administrator if access is restricted.

Problem 2: Secret Not Found

Cause: Incorrect Secret name while retrieving it in the Custom Code Node.
Solution:

1. Double-check the Secret name.

Problem 3: Incorrect Key-Value Pair

Cause: Incorrect credentials stored and retrieved.
Solution:

1. Verify that the correct credentials have been stored and retrieved.

Problem 4: Changes Not Saved

Cause: Page not refreshed.
Solution:

1. Refresh the page and confirm if the updated Key-Value Pair is reflected.

6. Additional information

7. FAQ

8. Summary

• The Secrets Manager enables secure storage, management, and retrieval of sensitive data.
• This guide covered:
  • Navigation to Secrets Manager
  • Steps to create and manage a Secret
  • Usage of Secrets in a Custom Code Node
  • Troubleshooting common issues

By following these steps, sensitive information within the system can be securely managed.