Skip to main content
The vault stores logins and API keys on behalf of each agent. Either kind can also hold a TOTP authenticator secret. Credential values are returned only by operations that explicitly reveal or generate them. Keep those results out of logs and chat transcripts. Credential reads are recorded in your organization’s audit history.

List credentials

GET /api/v1/vault returns account metadata only. Values are never included in the list response. Requires vault:metadata. The response contains a credentials array and next_cursor. Pass limit (1 to 100, default 100) and the previous next_cursor as cursor to retrieve another page. A null next_cursor means there are no more pages. The list includes the agent’s own credentials and credentials shared with it.
List credentials
string
Unique credential identifier.
string
Human-readable label set when the credential was created.
string
One of login or api_key.
boolean
Whether this credential has an authenticator secret configured.
boolean
Whether the agent may reveal the credential’s value with vault:use.

Get one credential

POST /api/v1/vault/:id/reveal returns a credential object containing its metadata, username, secret, and notes. Requires vault:use, and the credential must be marked agent-readable. The authenticator seed is not included; use the TOTP endpoint for a current code.
Reveal a credential
Every credential read is recorded in the org’s audit history, including which agent read it and when.

Create a credential

POST /api/v1/vault stores a new credential. Requires vault:write.
Create a credential with a generated password
When a password is generated, it is returned as generated_secret beside the credential object. Later reads use POST /api/v1/vault/:id/reveal or the get_credential MCP tool, require an agent-readable credential, and are audited.

Request body

string
required
Human-readable label for the credential.
string
required
Type of credential: login or api_key. Required on creation; it cannot be changed by an update.
string
Username or email address. Used when kind is login.
string
Password or API key. Required for api_key. A login password is generated when this field is omitted on creation.
boolean
For a login, set to true to generate a new strong password instead of using secret. The result is returned as generated_secret. API keys must be issued by their provider.
array
Exact HTTPS origins where the local connector may use this credential. A login requires at least one origin, such as https://accounts.example.com.
string
Base32 authenticator seed or otpauth://totp/... URI. Use this field to add TOTP without changing the password or API key. On update, an empty string removes TOTP.
boolean
Whether the agent may reveal values with vault:use. Defaults to true for credentials created by an agent. Only an owner or admin can make a human-created restricted credential agent-readable.
string
Account notes or recovery codes, up to 4 KB. Notes are included when the credential is revealed.

Rotate or update a credential

PATCH /api/v1/vault/:id rotates a password or adds a TOTP secret to an existing credential. Requires vault:write. Supply only the fields you want to change. Omitted fields retain their values. An agent can update its own credentials; credentials shared with it are managed by their owner. Use the MCP tool update_credential for the same operation from a chat client.

MCP tools for the vault

Use these MCP tools when working from a client like Claude Code, Codex, or Cursor:
Issue tokens with only the vault scopes each client needs. A read-only integration needs only vault:metadata; one that fills in passwords needs vault:use; one that creates accounts needs vault:write.