Create a Credential Input Source

post

/api/v2/credential_input_sources/

Make a POST request to this resource with the following credential input source fields to create a new credential input source:

  • description: Optional description of this credential input source. (string, default="")
  • input_field_name: (string, required)
  • metadata: (json, default={})
  • target_credential: (id, required)
  • source_credential: (id, required)

Request

Supported Media Types
Body ()
Root Schema : schema
Example:
{
    "input_field_name":"password",
    "metadata":{
        "key":"some_key"
    },
    "source_credential":"2",
    "target_credential":"1"
}
Back to Top

Response

Supported Media Types

201 Response

Body
Example Response (application/json)
{
    "created":"2018-02-01T08:00:00.000000Z",
    "description":"",
    "id":"1",
    "input_field_name":"password",
    "metadata":{
        "key":"some_key"
    },
    "modified":"2018-02-01T08:00:00.000000Z",
    "related":{
        "source_credential":"/api/v2/credentials/2/",
        "target_credential":"/api/v2/credentials/1/"
    },
    "source_credential":"2",
    "summary_fields":{
        "source_credential":{
            "cloud":false,
            "credential_type_id":"2",
            "description":"",
            "id":"2",
            "name":"external-cred"
        },
        "target_credential":{
            "cloud":false,
            "credential_type_id":"1",
            "description":"",
            "id":"1",
            "kind":"ssh",
            "name":"machine-cred"
        },
        "user_capabilities":{
            "delete":true
        }
    },
    "target_credential":"1",
    "type":"credential_input_source",
    "url":"/api/v2/credential_input_sources/1/"
}

400 Response

Body
Example Response (application/json)
{
    "metadata":{
        "key":[
            "required for External Service"
        ]
    }
}

403 Response

Body
Example Response (application/json)
{
    "detail":"You do not have permission to perform this action."
}
Back to Top