Creating a Secret
To add a new secret to the vault, follow these steps:- Navigate to the Secrets Section:
Go to the sidebar, select Settings, and then choose Secrets. - Click the
+icon to initiate the creation of a new secret. - Enter a descriptive name for the secret to help you identify its use.
- In the Value field, input the token, password, API key, or any other authentication details.
- Save the secret. Once configured, this secret can be selected and used within various components of ELITEA.
Managing Secrets
Secrets are managed securely via the Secrets Table, which displays all your configured secrets:- View Secret: Click the Eye icon to reveal the value of a configured secret.
- Copy Secret: Click the hidden value to copy the secret to your clipboard.
- Hide Secret: Hide the secret value to maintain security.
- Modify Secret: Update the value if the credentials change.
- Delete Secret: Permanently remove a secret from the vault if it is no longer needed.
Using Secrets in Credentials
When you create or edit a Credential in ELITEA (for example, for GitHub, Jira, or Azure DevOps), you can reference secrets you’ve stored in the vault instead of pasting sensitive values directly. This approach improves security and makes it easier to rotate or update secrets.How to Use a Secret in a Credential
- Create the Secret: First, create the secret as described above.
- Open the Credentials Menu: Go to Credentials in the main navigation.
- Create or Edit a Credential: Click
+ Createor open an existing credential. - Select the Relevant Field: For fields such as “API Key”, “Password”, or “Token”, you will see an option to reference a secret.
- Choose the Secret: Select your stored secret from the dropdown.
- Save the Credential: The credential will now use the referenced secret for authentication.
For detailed instructions on creating credentials, refer to the Create Credentials document.
Example
For a GitHub credential, you might see fields like:- Access Token (Secret)
- App Private Key (Secret)
- Password (Secret, optional)
Secrets in Practice: How It Works
- When a toolkit use a credential referencing a secret, ELITEA retrieves the secret from the vault for authentication.
- Secrets remain encrypted at rest and are never exposed in logs or exported configurations.
- If you update or rotate a secret, all credentials using this secret will use the new value automatically.
Best Practices
- Never hardcode credentials: Always store sensitive information as secrets.
- Use unique secrets for each integration or system.
- Rotate secrets regularly for enhanced security.
- Audit and delete unused secrets to minimize exposure.
Troubleshooting
- Secret Not Available in Dropdown: Refresh the secrets list or ensure you have permission to access the secret.
- Authentication Fails: Double-check that the secret value is correct and up to date.
- Can’t Edit/Delete Secret: You may lack permission; contact your system administrator.
For more information refer to the ELITEA documentation or your organization’s security guidelines.