Secrets Management¶
Creating, Sharing, Versioning, and Rotating Secrets
Document Version: 1.0.0
Last Updated: 2026-02-10
1. Secret Types¶
MazeVault supports the following secret types:
| Type | Description | Use Case |
|---|---|---|
password |
Passwords and passphrases | Database credentials, service accounts |
api_key |
API keys and tokens | Third-party service integration |
certificate |
TLS/SSL certificates with private keys | Service-to-service encryption |
ssh_key |
SSH key pairs | Server access, Git authentication |
generic |
Freeform key-value | Configuration values, connection strings |
2. Creating Secrets¶
Via Web Interface¶
- Navigate to Secrets → Select your project
- Click + New Secret
- Fill in the secret details:
- Name: Unique within the project (e.g.,
prod/database/master-password) - Value: The secret value
- Type: Secret type
- Description: What this secret is for
- Tags: Organizational tags
- Optionally configure rotation:
- Enable Rotation: Toggle on
- Rotation Interval: Days between automatic rotations
- Click Create
Via API¶
curl -X POST https://vault.example.com/api/v1/secrets \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"name": "prod/database/master-password",
"value": "s3cur3P@ssw0rd!",
"project_id": "proj_abc123",
"type": "password",
"description": "Production database master password",
"tags": ["production", "database"]
}'
3. Secret Versioning¶
Every update to a secret creates a new version. The version history provides:
- Audit trail — Who changed the secret and when
- Rollback capability — Revert to any previous version
- Change tracking — Whether the change was manual, rotation, or sync
Viewing Version History¶
- Navigate to the secret detail page
- Click the Versions tab
- View all versions with timestamps and change authors
Rolling Back¶
- In the version history, locate the desired version
- Click Rollback to this version
- Confirm the rollback
This creates a new version with the content of the selected historical version.
4. Secret Rotation¶
Manual Rotation¶
- Navigate to the secret detail page
- Click Rotate
- Enter the new secret value
- Click Confirm Rotation
Automated Rotation¶
Configure automatic rotation for secrets that need regular updates:
- Edit the secret → Rotation Settings
- Enable rotation
- Set the interval (e.g., 90 days)
- Save
The platform will automatically rotate the secret at the configured interval and notify connected agents.
Rotation Notifications¶
When a secret is rotated:
- All agents with access receive the update within the sync interval
- The audit log records the rotation event
- Dashboard shows the next rotation date
5. Secret Sharing¶
Secrets are shared through project membership and RBAC roles:
| Role | Read | Create | Update | Delete | Rotate |
|---|---|---|---|---|---|
| Viewer | ✅ | — | — | — | — |
| Editor | ✅ | ✅ | ✅ | — | — |
| Manager | ✅ | ✅ | ✅ | ✅ | ✅ |
| Admin | ✅ | ✅ | ✅ | ✅ | ✅ |
Sharing a Secret¶
- Ensure the target user is a member of the project
- Assign the appropriate role to the user
- The user can now access secrets according to their role
6. Secret Naming Conventions¶
We recommend organizing secrets with path-like naming:
<environment>/<service>/<name>
Examples:
prod/database/master-password
prod/api/stripe-key
staging/redis/auth-token
dev/aws/access-key
Using Tags¶
Tags provide additional organization:
| Tag | Purpose |
|---|---|
production |
Production environment secrets |
staging |
Staging environment secrets |
database |
Database credentials |
api-key |
Third-party API keys |
rotate-90d |
Secrets requiring 90-day rotation |
7. Secret Synchronization¶
For multi-datacenter deployments, secrets are synchronized automatically:
- Sync Interval: Configurable (default: 5 minutes)
- Conflict Resolution: Configurable per project (source wins / target wins / manual)
- Sync Status: Visible on the secret detail page and dashboard
Check Sync Status¶
- Navigate to the secret detail page
- View the Sync section showing each datacenter's status
- Status values:
synced,pending,conflict
Force Sync¶
If a secret is out of sync, force synchronization:
- Navigate to the secret detail page
- Click Force Sync
- The secret will be pushed to all configured targets
Related¶
- Secrets API — API reference for secrets
- Certificate Management — Managing certificates
- Quick Start — Getting started