Credential types and authenticator secrets
The credential kinds arelogin and api_key. Either kind can also hold a TOTP authenticator secret in its totp field.
Login
A username and password pair. The agent can generate a strong password at creation time; the generated value is returned once from the create call and stored encrypted. Use
get_credential to retrieve it later.API Key
A single secret string, such as a service token or bearer credential. Stored and retrieved the same way as a login, but without a username field.
TOTP Secret
An authenticator seed attached to a login or API key. The
get_totp_code tool returns the current code and its remaining lifetime without exposing the seed. Code length and timing follow the stored authenticator settings.Access scopes
Vault access is gated by three distinct scopes. Issue only what the client actually needs.
A token with only
vault:metadata can tell the agent what accounts exist without revealing a password. Add vault:use when the agent needs to read a secret to log in. Add vault:write when it needs to create credentials or rotate a stored secret. Both use and write include the metadata scope.
Working with credentials
- MCP tools
- REST API
Credential ownership
A credential does not have to belong exclusively to the agent whose token is being used. The vault supports three ownership levels:- Agent-owned: belongs to one agent. Other agents need an explicit share to access it. Authorized members can manage it in the dashboard.
- Shared: available to selected agents or all agents in the organization. Reading the value still requires
vault:useand the credential to be marked agent-readable. - Organization-held: belongs to the organization rather than to an agent. Agents need an explicit share to access it.
Audit history
Every time a credential’s value is read throughget_credential, get_totp_code, or the REST API, the event is written to the organization’s audit history. The record includes which agent made the request, which credential was accessed, and when. Audit history is visible to org members in the dashboard for 30 days on Pro (365 days with the Extended History add-on).
The organization’s audit log records access metadata (who, what, when) without credential values.
Local connector
For accounts that require browser-based login rather than an API key, you can pair a computer from the Vault page and use the local connector. The connector executes approved browser and app profiles on your machine without returning passwords, cookies, or page contents to the cloud.1
Pair your computer
Open the Vault page in the dashboard, click Pair a device, and run the pairing command on the computer you want to connect:
2
Start the connector
Configure your local MCP client to launch the connector on the paired machine using this command and the repository as its working directory. It speaks MCP over standard input and output:
3
Configure profiles
Define trusted website or app profiles in the connector’s config. The agent can use these profiles to perform browser-based actions without ever receiving the underlying credentials.
Next steps
Vault API reference
See the full MCP tool and REST endpoint reference for creating, reading, and rotating credentials.