Jump to

• Request
• Response

Update a Credential Type

put

/api/v2/credential_types/{id}/

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

• name: Name of this credential type. (string, required)
• description: Optional description of this credential type. (string, default="")

• kind: (choice, required)

  • net: Network
  • cloud: Cloud

• inputs: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

• injectors: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax. (json, default={})

For a PUT request, include all fields in the request.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Body ()

Root Schema : CredentialType

Type: object

Show Source

• created: string
  Title: Created

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

  Read Only: true
• injectors: object Injectors
  Title: Injectors

  Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.
• inputs: object Inputs
  Title: Inputs

  Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
• kind(required): string
  Title: Kind

  Allowed Values: [ "ssh", "vault", "net", "scm", "cloud", "registry", "token", "insights", "external", "kubernetes", "galaxy", "cryptography" ]
• managed: string
  Title: Managed

  Read Only: true
• modified: string
  Title: Modified

  Read Only: true
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 512
• namespace: string
  Title: Namespace

  Read Only: true

  Minimum Length: 1
• related: string
  Title: Related

  Read Only: true
• summary_fields: string
  Title: Summary fields

  Read Only: true
• 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"
        },
        "injectors":{
            "description":"Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.",
            "title":"Injectors",
            "type":"object"
        },
        "inputs":{
            "description":"Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.",
            "title":"Inputs",
            "type":"object"
        },
        "kind":{
            "enum":[
                "ssh",
                "vault",
                "net",
                "scm",
                "cloud",
                "registry",
                "token",
                "insights",
                "external",
                "kubernetes",
                "galaxy",
                "cryptography"
            ],
            "title":"Kind",
            "type":"string",
            "x-nullable":true
        },
        "managed":{
            "readOnly":true,
            "title":"Managed",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "namespace":{
            "minLength":"1",
            "readOnly":true,
            "title":"Namespace",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name",
        "kind"
    ],
    "type":"object"
}

Nested Schema : Injectors

Type: object

Title: Injectors

Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.

Nested Schema : Inputs

Type: object

Title: Inputs

Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : CredentialType

Type: object

Show Source

• created: string
  Title: Created

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

  Read Only: true
• injectors: object Injectors
  Title: Injectors

  Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.
• inputs: object Inputs
  Title: Inputs

  Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
• kind(required): string
  Title: Kind

  Allowed Values: [ "ssh", "vault", "net", "scm", "cloud", "registry", "token", "insights", "external", "kubernetes", "galaxy", "cryptography" ]
• managed: string
  Title: Managed

  Read Only: true
• modified: string
  Title: Modified

  Read Only: true
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 512
• namespace: string
  Title: Namespace

  Read Only: true

  Minimum Length: 1
• related: string
  Title: Related

  Read Only: true
• summary_fields: string
  Title: Summary fields

  Read Only: true
• 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"
        },
        "injectors":{
            "description":"Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.",
            "title":"Injectors",
            "type":"object"
        },
        "inputs":{
            "description":"Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.",
            "title":"Inputs",
            "type":"object"
        },
        "kind":{
            "enum":[
                "ssh",
                "vault",
                "net",
                "scm",
                "cloud",
                "registry",
                "token",
                "insights",
                "external",
                "kubernetes",
                "galaxy",
                "cryptography"
            ],
            "title":"Kind",
            "type":"string",
            "x-nullable":true
        },
        "managed":{
            "readOnly":true,
            "title":"Managed",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "namespace":{
            "minLength":"1",
            "readOnly":true,
            "title":"Namespace",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name",
        "kind"
    ],
    "type":"object"
}

Nested Schema : Injectors

Type: object

Title: Injectors

Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.

Nested Schema : Inputs

Type: object

Title: Inputs

Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.

Back to Top