Jump to

• Request
• Response

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

• application/json

Body ()

Root Schema : CredentialInputSource

Type: object

Show Source

• created: string
  Title: Created

  Read Only: true
• description: string
  Title: Description
• id: integer
  Title: ID

  Read Only: true
• input_field_name(required): string
  Title: Input field name

  Minimum Length: 1

  Maximum Length: 1024
• metadata: object Metadata
  Title: Metadata
• modified: string
  Title: Modified

  Read Only: true
• related: string
  Title: Related

  Read Only: true
• source_credential(required): integer
  Title: Source credential
• summary_fields: string
  Title: Summary fields

  Read Only: true
• target_credential(required): integer
  Title: Target credential
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "input_field_name":{
            "maxLength":"1024",
            "minLength":"1",
            "title":"Input field name",
            "type":"string",
            "x-nullable":true
        },
        "metadata":{
            "title":"Metadata",
            "type":"object"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "source_credential":{
            "title":"Source credential",
            "type":"integer",
            "x-nullable":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "target_credential":{
            "title":"Target credential",
            "type":"integer",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "input_field_name",
        "target_credential",
        "source_credential"
    ],
    "type":"object"
}

Nested Schema : Metadata

Type: object

Title: Metadata

Back to Top

Response

Supported Media Types

• application/json

201 Response

Body ()

Root Schema : CredentialInputSource

Type: object

Show Source

• created: string
  Title: Created

  Read Only: true
• description: string
  Title: Description
• id: integer
  Title: ID

  Read Only: true
• input_field_name(required): string
  Title: Input field name

  Minimum Length: 1

  Maximum Length: 1024
• metadata: object Metadata
  Title: Metadata
• modified: string
  Title: Modified

  Read Only: true
• related: string
  Title: Related

  Read Only: true
• source_credential(required): integer
  Title: Source credential
• summary_fields: string
  Title: Summary fields

  Read Only: true
• target_credential(required): integer
  Title: Target credential
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "input_field_name":{
            "maxLength":"1024",
            "minLength":"1",
            "title":"Input field name",
            "type":"string",
            "x-nullable":true
        },
        "metadata":{
            "title":"Metadata",
            "type":"object"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "source_credential":{
            "title":"Source credential",
            "type":"integer",
            "x-nullable":true
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "target_credential":{
            "title":"Target credential",
            "type":"integer",
            "x-nullable":true
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "input_field_name",
        "target_credential",
        "source_credential"
    ],
    "type":"object"
}

Nested Schema : Metadata

Type: object

Title: Metadata

Back to Top