Credentials

Create a credential

Stores a new credential for authenticating with an external source. The credential is created immediately and can be used on task runs.

post/credentials

Request body

source_idstring required

The source to authenticate against. Prefixed with src_.

auth_methodstring nullable

Authentication method for the source. One of username_password, source_fields, or none. Defaults to none if not provided.

external_idstring nullable

An identifier from your system to associate with this credential. Max 255 characters. See the external IDs guide for multi-tenant patterns.

Created

idstring required

Unique identifier for the credential, prefixed with cred_.

objectstring required

Always credential.

statusstring required

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

external_idstring nullable required

External identifier from your system, if set.

source_idstring required

The source this credential authenticates against. Prefixed with src_.

auth_methodstring required

Authentication method: username_password, source_fields, or none.

created_atstring date-time required

ISO 8601 timestamp of when the resource was created.

updated_atstring date-time required

ISO 8601 timestamp of when the resource was last updated.

request_idstring required

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

No recorded changes to this endpoint across all 1 revision of this API.