Skip to content

Secret Management

Team Edition supports external secret managers to securely store and access credentials.

Secret manager Description
AWS Secrets Manager Managed service from AWS for storing and retrieving secrets securely. Requires IAM permissions.
HashiCorp Vault Open-source tool for managing secrets and protecting sensitive data. Supports fine-grained access control.
CyberArk Enterprise-grade security platform designed for managing privileged access and secrets.

Configuring secret provider

Before configuring a secret provider in Team Edition, ensure that:

  • secret provider is set up
  • You have the necessary access permissions

  • secret management is enabled on the server

    Tip

    Learn now to enable it.

Add a secret provider

  1. Open Window -> Preferences -> Connections -> Secret providers
  2. Click Add button ()
  3. Select a provider from the dropdown menu and click OK
AWS secrets

  1. Fill in the required fields

    Field Description
    Name Identifier for the secret configuration in Team Edition.
    Cloud AWS configuration settings. For more details on configuring AWS Cloud in Team Edition, see AWS Cloud Explorer.
    Region AWS region where secrets are stored.

  2. Click OK and Apply and Close to save the configuration

Vault secrets

  1. Fill in the required fields

    Field Description
    Provider Identifier for the secret configuration in Team Edition.
    Name Unique name for this secret configuration.
    Server URL of the Vault server used to retrieve secrets.
    Authentication Type Select an authentication type (Token, JWT, Password).
    Global configuration (Optional) Apply this configuration globally across the application

  2. Click OK and Apply and Close to save the configuration

  3. Import certificate if required
CyberArk

  1. Fill in the required fields

    Field Description
    Name Unique identifier for the secret configuration in Team Edition.
    CyberArk Server URL URL of the Conjur OSS server (e.g., https://conjur.example.com).
    Account Conjur tenant or organization account name (e.g., myorg).
    Username Conjur user ID used for authentication.
    API Key API key associated with the Conjur user for authn login.
    Policy branch Path to the policy namespace where secrets are stored (e.g., dev/app).
    Trust Certificate (Optional) Trust the CyberArk server’s SSL certificate without manual import. Enable this if you're using a self-signed certificate or connecting to a server whose certificate isn't trusted by default.
    Global configuration (Optional) Apply this configuration globally across web and desktop clients of Team Edition

    Info

    For more details on authentication, policy structure, and SSL configuration, CyberArk official documentation.

  2. Click OK and Apply and Close to save the configuration

  3. If required, import the certificate

Authentication types

Password authentication

Use a username and password to authenticate with the Vault server.

Field Description
Username Username for authentication.
Password Password for authentication.
Token authentication

Use an authentication token to access the Vault server.

Field Description
Token Authentication token required to access the Vault server.
OAuth2 configuration

When you select OAuth2, Vault uses a JWT (JSON Web Token) issued by the OAuth2 provider after the user logs in.

Info

Make sure your OAuth2 provider issues JWTs, and Vault is configured to validate them. The JWT must include the claims needed for Vault role mapping.

Field Description
JWT provider ID Path where the JWT authentication method is enabled in Vault, for example, auth/jwt/.
JWT role Vault role name to match against a claim in the JWT token.
Auth URL OAuth2 Authorization endpoint (for example, https://example.com/oauth2/authorize).
Token URL OAuth2 Token endpoint (for example, https://example.com/oauth2/token).
Callback port Local port used to receive the OAuth2 authorization code. Default: 8000.
Callback URL Full callback URL automatically generated using the port. Example: http://localhost:8000/callback.
Client ID OAuth2 client ID registered in your OAuth2 provider.
Client secret OAuth2 client secret registered in your OAuth2 provider.

Info

For details on configuring JWT authentication in Vault, see Configuring JWT authentication.

JWT configuration

If you're using JWT to log in to Team Edition, the same token is automatically used to authenticate with Vault. You don't need to request a separate token. To configure JWT authentication, see JWT authentication setup.

If you want to customize how Vault handles the JWT token - such as selecting a specific role or provider - you can configure the fields below.

Field Description
JWT provider ID ID of the JWT provider configured in Vault (the Auth method name in Vault). The same provider you use to log in to the application.
JWT role claim The claim in the JWT that contains your custom role name. For details, see the configuration steps.
Global Configuration Shared settings for all users, like signature validation keys and encryption options. Each user authenticates with their own JWT from their login session.
Configuring JWT authentication

JWT authentication requires an external Single Sign-On (SSO) provider (e.g., Okta) because Vault does not generate JWTs internally. It works with any OpenID Connect (OIDC) provider that issues JWT tokens.

This configuration happens on the Vault side and includes setting up authentication methods, validation rules, and role mappings.

  1. Enable the JWT authentication method in Vault

    • enable JWT authentication
    • configure JWT validation settings, such as issuer and audience

  2. Create a role in Vault

    • vault does not assign roles automatically
    • use the API to create a role
    • define policies and specify claims for user identification

    a. Configure role assignment in the SSO provider

    • ensure your SSO provider includes user roles in the JWT

    Info

    Use the SSO provider’s documentation to configure role claims.

    b. Match the Vault Role Claim with a JWT claim

    • the Vault Role Claim field should match the custom claim in the JWT token.
    • if it does not match, authentication will fail.

Info

See the Vault documentation for more details.

Creating a connection

  1. Start creating a connection

  2. In the Create Connection wizard, go to the Main tab, choose secret provider configuration and enter the secret name in the Secret parameters field

    Info

    The secret name must match the name stored in your secret provider:

    -for HashiCorp Vault, use secret/your_secret_name - for AWS Secrets Manager, use your_secret_name - for CyberArk Conjur, use the full variable path, for example: app/dev/db/password. In Conjur, secret names reflect the full variable ID defined in your policy. For more details, see Conjur variables.

  3. If the secret doesn’t include all required details (such as the host or port), enter them manually in the connection settings

  4. Click the Test Connection button to verify your settings (if configured correctly, Team Edition will establish a connection using the Secret Provider)
  5. Click Finish to save the connection