Skip to main content

Overview

Use the Credentials page in the Poolside Console to store shared secrets and integration settings for agents and private repositories. This gives you one place to rotate values and review credential consumers. Use credentials when you need to centrally manage a reusable secret or login. Use Secrets when agents need to access sensitive values at runtime. Use Redaction patterns to protect sensitive-looking text that appears outside the managed credential or secret flow. When you enable agent use on a Secret credential and add it to an agent, the agent can resolve it as a remote secret at runtime. For more information about runtime behavior and redaction, see Secrets.

Typical workflow

To make a credential available to an agent:
  1. Create a credential in Security > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/credentials-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=c4046d647acddc3ca6d9d4c9b822df33 Credentials.
  2. Select Agents can use these credentials when configured if agents need access to the credential.
  3. After the agent exists, add the credential to the agent and enable the List secrets tool in the Context category so the agent can discover available credentials.
  4. Run the agent from Poolside Assistant or the pool CLI. At runtime, Poolside treats an agent-usable Secret credential as a remote secret.
Creating a credential does not automatically make it available to every agent or user. You must configure the credential for agent use and add it to a specific agent before that agent can use it.

Credential types

The Poolside Console can show the following managed credential types:
TypeWhat it’s for
SecretA single sensitive value, such as an API key or token.
Username / PasswordA credential pair for basic authentication or private repository access. Repository configuration uses this type for authentication.

Create a credential

Prerequisites
  • You have the Create Credential permission.
Steps
  1. In the Poolside Console, navigate to Security > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/credentials-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=c4046d647acddc3ca6d9d4c9b822df33 Credentials.
  2. Click New Credential.
  3. Enter a Name. Credential names cannot contain spaces, and you cannot change the name after creation.
  4. Optional: Enter a Description.
  5. Select a Type. You cannot change the type after creation:
    • Secret for a single secret value such as a token or API key
    • Username / Password for a paired login
  6. Enter the credential value:
    • For Secret, enter the secret value.
    • For Username / Password, enter both the username and password.
  7. Optional: Select Agents can use these credentials when configured if you want the credential to appear in agent configuration.
  8. Click Create Credential.
If you create a credential, you can still use, edit, and delete it even if you do not have the Use Credentials or Manage Credentials permission. Additional permissions are required for credentials created by other users.
Next steps
  1. To make a credential available to an agent:
    • If you did not select Agents can use these credentials when configured during creation, edit the credential and select it. This setting controls whether the credential appears in agent configuration.
    • After the agent exists, add the credential to the agent. You can add credentials only after you save the agent, not during agent creation.
  2. To use a credential with a Git repository, select it from the repository configuration.

Manage credentials

Use the Security > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/credentials-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=c4046d647acddc3ca6d9d4c9b822df33 Credentials page in the Poolside Console to find existing credentials and open the one you want to manage:
  • Search by credential name, description, or type.
  • Review the Consumers count to see how many resources currently reference each credential.
  • Customize the table to show Type, Created By, and Created in addition to the default columns.
  • Click a credential row to open its details page.

Edit a credential

Prerequisites
  • You have the Manage Credentials permission to edit credentials created by other users, or you created the credential.
Steps
  1. On the https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/credentials-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=c4046d647acddc3ca6d9d4c9b822df33 Credentials page, click the credential you want to update.
  2. Update the fields you want to change:
    • Update the Description if needed.
    • For Secret credentials, enter a new value to replace the stored secret. Secret values are never shown again after you save them, so leave the field empty to keep the existing stored value.
    • For Username / Password credentials, enter both a new username and a new password if you want to update either value. Leave both fields empty to keep the existing stored values.
    • Select or clear Agents can use these credentials when configured as needed.
  3. Click Save Changes.

View consumers

Prerequisites
  • You have the Manage Credentials permission.
Steps
  1. On the https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/credentials-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=c4046d647acddc3ca6d9d4c9b822df33 Credentials page, click the credential you want to review.
  2. Click Consumers.
  3. Review the grouped list of resources that reference the credential.

Delete a credential

Prerequisites
  • You have the Manage Credentials permission to delete credentials created by other users, or you created the credential.
Steps
  1. On the https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/credentials-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=c4046d647acddc3ca6d9d4c9b822df33 Credentials page, click the credential you want to delete.
  2. Click Delete.
  3. In the confirmation dialog, confirm the deletion.
Deleting a credential can break resources that still reference it. Review the Consumers list before you delete a credential.