What is AgentSecrets?
The Zero-Knowledge Difference
How AgentSecrets Works
Installation
Quick Start
Migrating from .env Files
Migrating from Vault / AWS
Migrating from dotenv-vault
Production Checklist
Credential Exposure
What Zero-Knowledge Means
The Proxy Model
The Three-Layer Model
Environments
Agent Identity
Storage Modes
The No get() Principle
Secret-Level Policies
Cloud Overview & Architecture
The Dual-Engine Model
Cloud Resolver Data Plane
Workload & Agent Tokens
Egress Allowlists & Audit Streams
Cloud REST API Reference
Account (init / login)
Server & Self-Hosting (server)
Docs
Shell Autocompletion
Keychain Auth
Secrets
Environments
Credential Proxy
env Injection
Workspaces & Teams
Projects
Agent Identity
Audit & Governance
Integrations Overview
Claude Desktop
Cursor
OpenClaw
HTTP Proxy (Any)
LangChain (Soon)
CrewAI (Soon)
CI/CD Pipeline
SDK Overview
Python SDK
Python API Reference
Python SDK Manual Testing
JavaScript SDK (Soon)
Ecosystem Overview
Zero-Knowledge MCP Server
Server Overview
5-Layer Architecture
Self-Hosting Guide
Authentication & Keys
Workspaces & Teams
Projects & Scope
Environments
Secrets & Sync Protocol
Agent Identity Resolution
Telemetry & Metrics Engine
Audit Log Sync
API Endpoint Reference
Security Overview
Anti-Impersonation & Process Verification
Encryption Model
Zero-Knowledge Sync
Proxy Security Layers
Threat Model
OWASP Top 10 Mitigation
Security FAQ
Third-Party Audit
Reporting Vulnerabilities
Guides Overview
Building on the SDK
Stripe Integration
OpenAI Integration
Multi-Agent Setup
Onboarding Team
CI/CD Pipeline
Publishing ZK MCP
Rotating Credentials
Auditing Team Activity
Dev to Production
Kubernetes Deployment
Monorepo Setup
Production Proxy Hardening
vs .env Files
vs HashiCorp Vault
vs AWS Secrets Manager
vs dotenv-vault
vs Infisical
When Not to Use
Proxy Not Starting
Proxy Not Resolving
Domain Blocked
Sync Conflicts
MCP Not Connecting
Session Token Errors
Proxy Session Authorization
Keychain Storage & Backends
SSRF & Destination Rules
Installation Issues
Error Codes Reference
Frequently Asked Questions
v3.1.x
v3.0.0
v2.1.0
v2.0.0
v1.4.0
v1.3.x
v1.2.0
v1.1.x
v1.0.x
Server & BackendAuthentication & Keys

Authentication

All requests to the AgentSecrets API (except for user registration, login, and token refresh) must be authenticated. The API implements JSON Web Tokens (JWT) and static service keys to authorize clients.


Token Types

The backend supports three categories of tokens:

1User Session Tokens

  • Who uses it: Human developers via the CLI or web dashboard.
  • Format: Standard JWT containing the user's UUID, email, and permissions.
  • Lifecycle: Access token expires in 6 hours; Refresh token uses standard JWT refresh lifetimes.
  • Storage: Saved locally on the developer's machine inside the secure OS Keychain (with token.json kept empty of sensitive data).

2Agent Tokens

  • Who uses it: Credential proxies, MCP servers, or background runners.
  • Format: Cryptographically signed agent tokens representing a specific declared identity.
  • Lifecycle: Configurable lifecycle (e.g., 24 hours up to 30 days) and scope. Can be revoked at any time.

3Service Keys

  • Who uses it: Internal backend-to-backend resolver components.
  • Format: High-entropy static bearer keys configured in the environment (RESOLVER_SERVICE_KEY).

Including Tokens in Requests

To authenticate a request, include the token in the Authorization header as a Bearer token:

Authorization: Bearer <your_jwt_or_agent_token>

For internal resolver calls, the backend acceptsAuthorization: Bearer <resolver_service_key> or matches the service key against a custom internal header, falling back to User JWT authentication if service key validation is not enforced.


Expiry and Refresh Flow

To prevent developers from being logged out during long-running tasks or background syncing (such as the proxy daemon syncing audit logs to the cloud), the CLI API client implements an automatic retry mechanism.

  1. 401 Detection: If an API request to a private endpoint fails with a 401 Unauthorized status (indicating the Access Token has expired), the client pauses.
  2. Dynamic Refresh: The client issues a POST request to /api/auth/refresh/ using the stored Refresh Token.
  3. Save and Retry: If the refresh is successful, the new Access and Refresh tokens are persisted to the secure OS Keychain (leaving the local token.json file empty of secrets) and the failed request is re-built and executed exactly once with the new token.
  4. Concurrency Protection: The refresh flow is locked using a mutex (refreshMu) to ensure that multiple parallel asynchronous requests do not cause a "refresh storm" by hitting the refresh endpoint concurrently.

Revocation

Tokens can be revoked in three ways:

  • Logout: Running agentsecrets logout calls the /api/auth/logout/ endpoint, blacklisting the active refresh token.
  • Agent Revocation: Through the workspaces dashboard or CLI:
    agentsecrets agent token revoke <token_id>
  • Password Change: Changing your master password automatically invalidates all existing active user sessions.
Was this helpful?
Thanks for your feedback!
Your feedback helps us improve the platform.