Create Credential Using POST

Create Credential Using POST

Create a new Credential Instance

Request
URI
POST
https://{api_host}/api/credentials
COPY
Request Body

The Credential Instance information

credential of type(s) application/json
Required

Show optional properties

{
    "adapterKindKey": "string",
    "credentialKindKey": "string",
    "name": "string"
}
{
    "adapterKindKey": "string",
    "credentialKindKey": "string",
    "fields": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "id": "string",
    "name": "string"
}
string
adapterKindKey
Required

The Adapter Kind key of the Credential

string
credentialKindKey
Required

The credential kind of the credential

array of name-value
fields
Optional

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

string As uuid As uuid
id
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

The name of the Credential

Authentication
This operation uses the following authentication methods.
Responses
201

The Credential Instance created

Returns credential of type(s) application/json
{
    "adapterKindKey": "string",
    "credentialKindKey": "string",
    "fields": [
        {
            "name": "string",
            "value": "string"
        }
    ],
    "id": "string",
    "name": "string"
}
string
adapterKindKey
Required

The Adapter Kind key of the Credential

string
credentialKindKey
Required

The credential kind of the credential

array of name-value
fields
Optional

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

string As uuid As uuid
id
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

The name of the Credential


400

Invalid request parameters or request body

Operation doesn't return any data structure

422

Credential Instance with same name already exists

Operation doesn't return any data structure