curl --request POST \
--url https://api.deck.co/v2/credentials \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source_id": "src_AbC123xYz456",
"auth_method": "username_password",
"auth_credentials": {
"username": "user@example.com",
"password": "..."
},
"external_id": "cust_42"
}
'{
"id": "cred_AbC123xYz456",
"object": "<string>",
"status": "<string>",
"external_id": "<string>",
"source_id": "<string>",
"auth_method": "<string>",
"auth_credentials": {
"username": "<string>",
"email": "<string>",
"source_fields": {},
"tokenized": [
"<string>"
]
},
"persistence": {
"enabled": true
},
"geolocation": {
"country": "US"
},
"created_at": "2026-08-24T12:00:00Z",
"updated_at": "2026-08-24T12:00:00Z",
"request_id": "<string>"
}{
"errors": {},
"type": "<string>",
"title": "<string>",
"status": 123,
"traceId": "<string>"
}{
"errors": [
{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"request_id": "<string>"
}{
"errors": [
{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"request_id": "<string>"
}{
"errors": [
{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"request_id": "<string>"
}{
"errors": [
{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"request_id": "<string>"
}{
"errors": [
{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"request_id": "<string>"
}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.
curl --request POST \
--url https://api.deck.co/v2/credentials \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"source_id": "src_AbC123xYz456",
"auth_method": "username_password",
"auth_credentials": {
"username": "user@example.com",
"password": "..."
},
"external_id": "cust_42"
}
'{
"id": "cred_AbC123xYz456",
"object": "<string>",
"status": "<string>",
"external_id": "<string>",
"source_id": "<string>",
"auth_method": "<string>",
"auth_credentials": {
"username": "<string>",
"email": "<string>",
"source_fields": {},
"tokenized": [
"<string>"
]
},
"persistence": {
"enabled": true
},
"geolocation": {
"country": "US"
},
"created_at": "2026-08-24T12:00:00Z",
"updated_at": "2026-08-24T12:00:00Z",
"request_id": "<string>"
}{
"errors": {},
"type": "<string>",
"title": "<string>",
"status": 123,
"traceId": "<string>"
}{
"errors": [
{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"request_id": "<string>"
}{
"errors": [
{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"request_id": "<string>"
}{
"errors": [
{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"request_id": "<string>"
}{
"errors": [
{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"request_id": "<string>"
}{
"errors": [
{
"type": "<string>",
"code": "<string>",
"message": "<string>",
"field": "<string>"
}
],
"request_id": "<string>"
}Headers
Optional key that makes the request idempotent. Retrying with the same key returns the original response instead of repeating the operation; keys expire after 24 hours. Any string up to 256 characters. See Idempotency.
256"550e8400-e29b-41d4-a716-446655440000"
Body
Request body for creating a new credential.
Credentials payload. Structure depends on auth_method. For username_password, pass username and password. For username, pass only username, for sources that sign in without a password. For google_sso and apple_sso, pass email and password for the end user's Google or Apple Account. 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.
Show child attributes
Show child attributes
Response
Created
Was this page helpful?