Skip to main content

Secrets Management

Secrets can be registered in Personal Profiles, allowing sensitive information such as access keys, tokens, and credentials to be securely used in individual contexts.

In the StackSpot AI context, Secrets can be used in Quick Commands and Tools.

Follow the steps below to register, edit, and delete a Secret:

Requirements

You need one of the following permissions: writer or account holder. For more information, access the Roles and Permissions page.

Steps: Registering a Secret

Step 1. Go to the StackSpot AI Portal;

Step 2. Click the 'Spots' section;

Step 3. Then, access the 'Secrets' subsection;

Step 4. Click the 'Register Secret' button to start the registration process;

Step 5. Select the type of Secret you want to register and fill in the specific information according to the selected type. See the details below:

Types of Secrets and their required fields

  1. API Key: Used to authenticate client application requests to APIs. Fill in the following fields:
  • Secret Name
  • Header Name
  • Value
  • Expiration Date (Optional)
  1. Bearer Tokens (OAuth): Tokens issued as part of the OAuth2 authorization framework, allowing clients to access protected resources. Fill in the following fields:
  • Secret Name
  • Header Name
  • Header Value
  • Expiration Date (Optional)
  1. Client Credentials: Commonly used for server-to-server communication, where a client application must authenticate using client credentials. Fill in the following fields:
  • Secret Name
  • Client ID
  • URL
  • Client Secret
  1. Certificate: Client certificates are used for mutual TLS authentication, ensuring identity validation and encrypted communication. Fill in the following fields:
  • Secret Name
  • Certificate: drag and drop your files.
  • Private Key (Optional): drag and drop your files. Only .key files are supported.
  • Expiration Date: automatically filled in when you add the certificate.
  1. Key/Value. Fill in the following fields:
  • Secret Name
  • Registration Method: choose between uploading a file or entering manually (add the key and value).
  • Expiration Date (Optional)

Step 6. Click the 'Register Secret' button;

Step 7. After registration, check your Secret in the listing screen. You will be able to view information such as:

  • Credential Type
  • Creation Date
  • Expiration Date
  • Secret Status

How to edit a Secret

danger

  • Make sure to copy and save the Secret information when registering it. The data will not be displayed again.

  • Use the edit feature to review where the Secret is used before making any changes or deletions.

You can edit a registered Secret by following these steps:

Step 1. In the StackSpot AI Portal, go to the 'Spots' section;

Step 2. Click the 'More Options' button next to the Secret you want to edit;

Step 3. Now, click the 'Edit' button to edit the secret. Fill in the required fields:

  • New Header Name
  • New Value
  • Expiration Date (Optional)

How to delete a Secret

If you don’t use a Secret for 30 days, it will automatically become inactive.

The StackSpot Portal will notify you 15, 10, and 1 day before a Secret is deleted. After a Secret becomes inactive, you have a few options:

  • Use the Secret again within 30 days to reactivate it. This will change its status from "Scheduled for Deletion" to "Active."

  • Delete the Secret right away.

  • Schedule the Secret for deletion in 30 days.

See below for the step-by-step for the last two options: Delete a Secret now and Schedule Secret deletion.

Delete a Secret Now

You can delete a Secret right away if it is in any of the following statuses:

  • Active
  • Inactive
  • Scheduled for Deletion
danger

Deleting a Secret cannot be undone.

Step 1. In the 'Secrets' subsection, click the 'More Options' button;

Step 2. Click the 'Delete Secret' button;

Step 3. Then, select the Delete now option;

Before deleting, you can view and search all the places where the Secret is used.

Step 4. To finish, type DELETE. Then, click the 'Delete secret' button.

Now the secret will be deleted within 30 days.

Schedule Secret deletion

Step 1. Still in the 'Secrets' subsection, click the 'More Options' button;

Step 2. Click the 'Delete Secret' button;

Step 3. Then, select the Schedule deletion option;

Step 4. To finish, type DELETE. Then, click the 'Delete secret' button.

Done, you have scheduled the deletion of a Secret.