Guides
Log In
Guides

How to Configure Secrets

Prerequisites

  • For an overview of the Cyolo Vault feature, refer to the section: Overview.

Configuration

  • Log in to the Cyolo Admin Portal.

  • On the left panel, click Vault and select Secrets .

  • On the Vault > Secrets page, click the Add button at the top right side.

General Info

  • Secret name: Enter a descriptive name for the secret.

  • Description: Provide a description of the secret that reflects its purpose and usage.

  • Secret type: From the drop-down menu, select any one of the following type of secrets:

    a) Password

    b) Private Key

    c) Certificate

    d) API Key

    e) Generic

Settings

The Settings section is for the details of the secret. The fields shown here change according to the type of secret selected in the General Info section:

Password --

  • Username: Enter the username associated with the password.

  • Password: Enter the password.

Private Key:

  • Username: Enter the username associated with the private key.

  • Private Key: Enter the private key.

Note: The private key is only visible at the time of adding it on the page.

Certificate:

  • Certificate Data: Click the upload icon and select the certificate file (without the private key), or paste its content here.
  • Private Key: Click the upload icon and select the private key file, or paste its content here.

Note: The private key is only visible at the time of adding it on the page.

API Key:

  • Key ID: Enter the API key ID.

  • Key Secret: Enter the API key secret.

Generic:

  • Value: Enter the value of the generic secret.

Labels (Optional)

Use the Labels section to add labels that help categorize and manage your secrets. This step is optional but can be useful for organizing the secrets.

  • Click the Search bar to select a label from the existing list.
  • To create a new label from this window, click the Create new label button.

  • On the Add New Label window:

  • Enter a label name.

  • Enter a description of the label.

  • Choose a colour from the palette or enter the colour value for a custom colour.

  • Click Save at the top right of the page to create the secret.

Create Labels on the Secrets Page

You can use labels for your secrets to categorize or group them. You can also apply access rules to grouped secrets. These labels help group secrets and can be assigned a colour for better organization. To create new labels for secrets in the vault, follow these steps:

  • Go to the Vault > Secrets page. Click the drop-down next to the Add button and select Label.
  • In the General Info section, enter the label name, choose a colour from the palette, or enter the colour value for a custom colour.

  • In the Select Secrets section, search for the secrets you created earlier.

Assign Secrets to Applications

For the secrets added on the Secrets page to be used for authenticating a resource, they must be assigned
to applications on the Applications page. Secrets can be assigned either while creating applications or by editing an existing application.

  • Go to the Applications page.

  • Edit an existing application or create a new application.

  • Under the Authentication Method section, select Basic or Private Key under Sign-in Settings.

  • Select Assign secret from vault.

  • From the drop-down, select the secret that you want to use.