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. |
Note
If a secret is configured, it takes priority over other authentication settings.
Configure secret provider¶
Before adding a secret provider in Team Edition, make sure:
- the provider is set up and accessible
- you have the required permissions
- secret management is enabled in the server configuration
Turn on secret management¶
- Go to Settings -> Administration -> Server Configuration
- In the Configuration section, enable Secret Management
- Click Save
Once enabled, a new Secret Management tab appears in the interface.
Add a secret provider¶
- Open the Secret Management tab
- Click + Add
- Choose a provider from the dropdown list
AWS secrets¶
-
Fill in the required fields
Field Description ID Enter a unique identifier for the configuration. Configuration name Enter a descriptive name for this configuration. Description (Optional) Provide a brief description of this secret provider configuration. CloudId AWS configuration settings. For more details on configuring AWS Cloud in Team Edition, see AWS Cloud Explorer. Region AWS region where secrets are stored. -
Click Create to save the configuration
Vault secrets¶
-
Fill in the required fields
Field Description ID Enter a unique identifier for the configuration. Configuration name Enter a descriptive name for this configuration. Description (Optional) Provide a brief description of this secret provider. Authentication Type Select an authentication type ( TOKEN
,JWT
,USERNAME_PASSWORD
).Note
When using
USERNAME_PASSWORD
orTOKEN
authentication, all users will have the same level of access to all secrets. If you need access control with different permissions for users, useJWT
authentication. -
Click Create to save the configuration
CyberArk¶
-
Fill in the required fields
Field Description ID Enter a unique identifier for the configuration. Configuration name Unique identifier for the secret configuration in Team Edition. Description (Optional) Provide a brief description of this secret provider. Server URL URL of the Conjur OSS server (e.g., https://conjur.example.com
).Account Conjur tenant or organization account name (e.g., myorg
).Login 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 CyberArk SSL 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. Info
For more details on authentication, policy structure, and SSL configuration, CyberArk official documentation.
-
Click Create to save the configuration
Authentication types¶
Username/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. |
JWT authentication¶
Use a JSON Web Token (JWT) for authentication.
Field | Description |
---|---|
Vault server URL | URL of the Vault server used to retrieve secrets. |
Vault JWT Provider ID | Identifier for the JWT provider created on the Vault side (Auth Method in Vault). |
Vault Role Claim | The value of the role name in the JWT token where the custom role is stored. See the configuration steps below. |
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.
Note
You must be logged into Team Edition with the same authentication provider that Vault is configured with. For instance, if Vault is set up with Okta, you must log in through Okta-logging in through a different provider, like Google, will not work.
-
Enable the JWT authentication method in Vault
- enable JWT authentication
- configure JWT validation settings, such as issuer and audience
-
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¶
- Start creating a connection
-
In the Create Connection wizard, go to the Main tab, choose a secret provider configuration and enter the secret name in the Settings 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, useyour_secret_name
- for CyberArk, 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 documentation. -
If the secret doesnāt include all required details (such as the
host
orport
), enter them manually in the connection settings. - Click the Test button to verify your settings (if configured correctly, Team Edition will establish a connection using the Secret Provider)
- Click Create to save the connection