Partial Update Credential

Partial update an existing Credential Instance

Request

URI

PATCH

https://{api_host}/suite-api/api/credentials

COPY

Request Body

The Credential Instance information to update

credential of type(s) application/json

Required

Show optional properties

{
    "name": "string",
    "adapterKindKey": "string",
    "credentialKindKey": "string"
}

"{\n  \"id\" : \"c3e5ea54-d597-4868-8419-07510affd8ec\",\n  \"name\" : \"My VC Credential\",\n  \"adapterKindKey\" : \"VMWARE\",\n  \"credentialKindKey\" : \"PRINCIPALCREDENTIAL\",\n  \"fields\" : [ {\n    \"name\" : \"USER\",\n    \"value\" : \"root\"\n  }, {\n    \"name\" : \"PASSWORD\"\n  } ]\n}"

string As uuid As uuid

Optional

Credential Instance identifier.
This should be null for credential instance creation requests and must have a value for all other requests.

string

name

Required

Constraints: minLength: 3 maxLength: 200

The name of the Credential

string

adapterKindKey

Required

The Adapter Kind key of the Credential

string

credentialKindKey

Required

The credential kind of the credential

array of object

fields

Optional

Collection of name,value pairs that capture the credential specific data

boolean

editable

Optional

Is credential editable or not

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The updated credential instance

Returns credential of type(s) application/json

"{\n  \"id\" : \"7f698874-b0b9-487e-9318-bef00adf58ed\",\n  \"name\" : \"My VC Credential\",\n  \"adapterKindKey\" : \"VMWARE\",\n  \"credentialKindKey\" : \"PRINCIPALCREDENTIAL\",\n  \"fields\" : [ {\n    \"name\" : \"USER\",\n    \"value\" : \"root\"\n  }, {\n    \"name\" : \"PASSWORD\"\n  } ]\n}"

string As uuid As uuid

Optional

Credential Instance identifier.
This should be null for credential instance creation requests and must have a value for all other requests.

string

name

Required

Constraints: minLength: 3 maxLength: 200

The name of the Credential

string

adapterKindKey

Required

The Adapter Kind key of the Credential

string

credentialKindKey

Required

The credential kind of the credential

array of object

fields

Optional

Collection of name,value pairs that capture the credential specific data

boolean

editable

Optional

Is credential editable or not

400

The operation is not allowed for credential with this type

Operation doesn't return any data structure

404

The Credential Instance does not exist

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"adapterKindKey:"string","credentialKindKey:"string","name:"string"}'

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Credentials Operations

GET

Get Credentials

PUT