Retrieve a Credential Input Source

get

/api/v2/credential_input_sources/{id}/

Make GET request to this resource to retrieve a single credential input source record containing the following fields:

  • id: Database ID for this credential input source. (integer)
  • type: Data type for this credential input source. (choice)
  • url: URL for this credential input source. (string)
  • related: Data structure with URLs of related resources. (object)
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
  • created: Timestamp when this credential input source was created. (datetime)
  • modified: Timestamp when this credential input source was last modified. (datetime)
  • description: Optional description of this credential input source. (string)
  • input_field_name: (string)
  • metadata: (json)
  • target_credential: (id)
  • source_credential: (id)

Request

Supported Media Types
Path Parameters
Query Parameters
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":"vault_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":"vault",
            "name":"test-cred"
        },
        "user_capabilities":{
            "delete":false
        }
    },
    "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