Skip to main content
POST
/
v5
/
credentials
Create Credential
curl --request POST \
  --url https://api.egp.scale.com/v5/credentials \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "type": "<string>",
  "name": "<string>",
  "description": "<string>",
  "payload": "<string>",
  "credential_metadata": {}
}'
{
  "id": "<string>",
  "object": "credential",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "<string>",
  "type": "<string>",
  "name": "<string>",
  "description": "<string>",
  "credential_metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Headers

x-selected-account-id
string | null

Body

application/json
type
string
required

Type of credential: key or json

Minimum length: 1
name
string
required

User-friendly name for the credential

Minimum length: 1
payload
string<password>
required

The credential payload to be encrypted

Minimum length: 1
description
string

Optional description

credential_metadata
object

Optional unencrypted credential_metadata

Response

Successful Response

id
string
required
created_by_user_id
string
required
created_by_identity_type
string
required
type
string
required
name
string
required
description
string
required
credential_metadata
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
object
string
default:credential
I