Create a credential

POST/credentials

Create a new credential for storing login information.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to create a new credential

name*string

Unique name for the credential within the project

domain*string

Target domain this credential is for

values*

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

totp_secret?string

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

sso_provider?string

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.

Response

application/json

Credential created successfully

A stored credential for automatic re-authentication

id*string

Unique identifier for the credential

name*string

Unique name for the credential within the project

domain*string

Target domain this credential is for

created_at*string

When the credential was created

Formatdate-time

updated_at*string

When the credential was last updated

Formatdate-time

has_values?boolean

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

has_totp_secret?boolean

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

value_keys?array<string>

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_provider?string

totp_code?string

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

totp_code_expires_at?string

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

Formatdate-time

curl -X POST "https://example.com/credentials" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "domain": "string",    "values": {      "property1": "string",      "property2": "string"    }  }'

{  "id": "string",  "name": "string",  "domain": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "has_values": true,  "has_totp_secret": true,  "value_keys": [    "string"  ],  "sso_provider": "string",  "totp_code": "string",  "totp_code_expires_at": "2019-08-24T14:15:22Z"}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}