Skip to main content
PATCH
Update a credential

Authorizations

Authorization
string
header
required

Secret key (sk_live_...)

Path Parameters

credential_id
string
required

Unique identifier for the credential (prefixed with cred_).

Body

Request body for updating a credential. Only include fields you want to change.

auth_credentials
object

Credentials payload. Structure depends on auth_method. For username_password, pass username and password. For source_fields, pass at least one entry in source_fields. Any auth_method except none may also include source_fields alongside its credentials (for example, username and password plus source_fields in the same payload), and tokenized to vault selected source-field values.

external_id
null | string

Updated external identifier. Set to null to remove the mapping.

persistence
object

Updated persistence settings. Setting enabled to false permanently deletes the saved login state.

Response

OK

id
string
required

Unique identifier for the credential, prefixed with cred_.

object
string
required

Always credential.

status
string
required

Credential status: unverified, verified, invalid, or deleted.

source_id
string
required

The source this credential authenticates against. Prefixed with src_.

auth_method
string
required

Authentication method: username_password, source_fields, or none.

auth_credentials
null | object
required

Summary of stored credentials. Sensitive values are not returned.

persistence
object
required

Persistence settings for this credential.

external_id
null | string
required

External identifier from your system, if set.

created_at
string<date-time>
required

ISO 8601 timestamp of when the resource was created.

updated_at
string<date-time>
required

ISO 8601 timestamp of when the resource was last updated.

request_id
string
required

Unique identifier for the API request. Include this when contacting support.