Update a Credential Type

patch

/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 PATCH request, include only the fields that are being modified.

Request

Supported Media Types
Path Parameters
Query Parameters
Body ()
Root Schema : schema
Example:
{
    "name":"Some Other Name"
}
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "created":"2018-02-01T08:00:00.000000Z",
    "description":"",
    "id":"1",
    "injectors":{
    },
    "inputs":{
    },
    "kind":"cloud",
    "managed":false,
    "modified":"2018-02-01T08:00:00.000000Z",
    "name":"Some Other Name",
    "namespace":null,
    "related":{
        "activity_stream":"/api/v2/credential_types/1/activity_stream/",
        "credentials":"/api/v2/credential_types/1/credentials/"
    },
    "summary_fields":{
        "user_capabilities":{
            "delete":true,
            "edit":true
        }
    },
    "type":"credential_type",
    "url":"/api/v2/credential_types/1/"
}

401 Response

Body
Example Response (application/json)
{
    "detail":"Authentication credentials were not provided. To establish a login session, visit /api/login/."
}

403 Response

Body
Example Response (application/json)
{
    "detail":"Modifications to inputs are not allowed for credential types that are in use"
}
Back to Top