Sign in

v97

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-31135175384.2 KB
Credentials

Create a credential

Create a new credential for storing login information.

post/credentials

Request body

namestring required

Unique name for the credential within the project

domainstring required

Target domain this credential is for

valuesobject required

Field name to value mapping (e.g., username, password)

totp_secretstring

Base32-encoded TOTP secret for generating one-time passwords. Used for automatic 2FA during login.

sso_providerstring

If set, indicates this credential should be used with the specified SSO provider (e.g., google, github, microsoft). When the target site has a matching SSO button, it will be clicked first before filling credential values on the identity provider's login page.

Example request

{
  "name": "my-netflix-login",
  "domain": "netflix.com",
  "values": {
    "username": "user@example.com",
    "password": "mysecretpassword"
  },
  "totp_secret": "JBSWY3DPEHPK3PXP",
  "sso_provider": "google"
}

Response

Credential created successfully

idstring required

Unique identifier for the credential

namestring required

Unique name for the credential within the project

domainstring required

Target domain this credential is for

created_atstring date-time required

When the credential was created

updated_atstring date-time required

When the credential was last updated

has_valuesboolean

Whether this credential has stored values (email, password, etc.)

has_totp_secretboolean

Whether this credential has a TOTP secret configured for automatic 2FA

value_keysstring[]

The field names stored in this credential's values (e.g., username, password). Values themselves are never returned. Included on single-credential responses (create, get by id or name, update); omitted from list responses.

sso_providerstring nullable

If set, indicates this credential should be used with the specified SSO provider (e.g., google, github, microsoft). When the target site has a matching SSO button, it will be clicked first before filling credential values on the identity provider's login page.

totp_codestring

Current 6-digit TOTP code. Only included in create/update responses when totp_secret was just set.

totp_code_expires_atstring date-time

When the totp_code expires. Only included when totp_code is present.

Example response

{
  "id": "cred_abc123xyz",
  "name": "my-netflix-login",
  "domain": "netflix.com",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:00Z",
  "has_values": true,
  "value_keys": [
    "username",
    "password"
  ],
  "sso_provider": "google",
  "totp_code": "847291",
  "totp_code_expires_at": "2025-01-15T10:30:30Z"
}