Update a Credential Input Source

patch

/api/v2/credential_input_sources/{id}/

Make a PUT or PATCH request to this resource to update this credential input source. The following fields may be modified:

  • 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)

For a PATCH request, include only the fields that are being modified.

Request

Supported Media Types
Path Parameters
Query Parameters
Body ()
Root Schema : schema
Example:
{
    "metadata":{
        "key":"some_other_key"
    }
}
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "created":"2018-02-01T08:00:00.000000Z",
    "description":"",
    "id":1,
    "input_field_name":"password",
    "metadata":{
        "key":"some_other_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/"
}

403 Response

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