v97

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

Credentials

Update credential

Update a credential's name or values. When values are provided, they are merged with existing values (new keys are added, existing keys are overwritten).

patch/credentials/{id_or_name}

Path parameters

id_or_namestring required

Credential ID or name

Request body

namestring

New name for the credential

valuesobject

Field name to value mapping. Values are merged with existing values (new keys added, existing keys overwritten).

remove_value_keysstring[]

Field names to remove from the credential's stored values. Removals are applied before values are merged, so a key present in both is kept with its new value.

totp_secretstring

Base32-encoded TOTP secret for generating one-time passwords. Spaces and formatting are automatically normalized. Set to empty string to remove.

sso_providerstring nullable

If set, indicates this credential should be used with the specified SSO provider. Set to empty string or null to remove.

Example request

{
  "name": "my-updated-login",
  "values": {
    "username": "user@example.com",
    "password": "newpassword"
  },
  "remove_value_keys": [
    "old_field"
  ],
  "totp_secret": "JBSWY3DPEHPK3PXP",
  "sso_provider": "google"
}

Response

Credential updated 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"
}