Update Credential

PATCH/v5/credentials/{credential_id}

Update an existing credential’s properties including name, description, type, payload, and metadata.

Path ParametersExpand Collapse

credential_id: string

Body ParametersJSONExpand Collapse

credential_metadata: optional map[unknown]

Optional unencrypted credential_metadata

description: optional string

Optional description

name: optional string

User-friendly name for the credential

payload: optional string

The credential payload to be encrypted

formatpassword

type: optional string

Type of credential: key or json

ReturnsExpand Collapse

Credential object { id, created_at, created_by_identity_type, 7 more }

id: string

created_at: string

formatdate-time

created_by_identity_type: string

created_by_user_id: string

credential_metadata: map[unknown]

description: string

name: string

type: string

updated_at: string

formatdate-time

object: optional string

Update Credential

curl https://api.egp.scale.com/v5/credentials/$CREDENTIAL_ID \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $SGP_API_KEY" \
    -d '{}'

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by_identity_type": "created_by_identity_type",
  "created_by_user_id": "created_by_user_id",
  "credential_metadata": {
    "foo": "bar"
  },
  "description": "description",
  "name": "name",
  "type": "type",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "object": "object"
}

Returns Examples

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "created_by_identity_type": "created_by_identity_type",
  "created_by_user_id": "created_by_user_id",
  "credential_metadata": {
    "foo": "bar"
  },
  "description": "description",
  "name": "name",
  "type": "type",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "object": "object"
}