v1

latestOpenAPI 3.0.02026-07-26300209.6 KB
Vault

Connect a vault provider

Connect a supported password manager and immediately sync display-safe credential metadata.

post/v1/vault/connections

Request body

provider'1password' | 'bitwarden' required

Vault provider identifier.

tokenstring

1Password service account token. Required when provider is 1password.

clientIdstring

Bitwarden client ID. Required when provider is bitwarden.

clientSecretstring

Bitwarden client secret. Required when provider is bitwarden.

masterPasswordstring

Bitwarden master password. Required when provider is bitwarden.

serverUrlstring uri

Optional self-hosted Bitwarden server URL.

Example request

{
  "provider": "1password",
  "serverUrl": "https://vault.example.com"
}

Response

Vault connected successfully.

connectionIdstring required
connectedtrue required
provider'1password' | 'bitwarden' required

Vault provider identifier.

Example response

{
  "connectionId": "conn_123",
  "provider": "1password",
  "items": [
    {
      "itemId": "cred:conn-123:Personal:item-abc123",
      "connectionId": "conn_123",
      "label": "Amazon Login",
      "vaultName": "Personal",
      "domains": [
        "amazon.com"
      ],
      "fieldMetadata": [
        {
          "fieldId": "password",
          "label": "Password",
          "type": "CONCEALED"
        }
      ],
      "hasTotp": true
    }
  ]
}