移動先

• リクエスト
• レスポンス

資格証明の更新

patch

/api/v2/credentials/{id}/

このリソースに対してPUTまたはPATCHリクエストを行って、この資格証明を更新します。次のフィールドを変更できます。

• name: この資格証明の名前。(文字列、必須)
• description: この資格証明のオプションの説明。(文字列、デフォルト="")
• organization: (id、デフォルト=None)

• credential_type: 作成する資格証明のタイプを指定します。各タイプの詳細は、ドキュメントを参照してください。(id、必須)

• inputs: JSONまたはYAML構文を使用して入力を入力します。構文例は、ドキュメントを参照してください。(json、デフォルト={})

PATCHリクエストの場合は、変更中のフィールドのみを含めます。

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• id(必須): 文字列

本文()

ルート・スキーマ : Credential

型: object

ソースを表示

• cloud: 文字列
  タイトル: Cloud

  読取り専用: true
• created: 文字列
  タイトル: Created

  読取り専用: true
• credential_type(必須): 整数
  タイトル: Credential Type

  作成する資格証明のタイプを指定します。各タイプの詳細は、ドキュメントを参照してください。
• description: 文字列
  タイトル: Description
• id: 整数
  タイトル: ID

  読取り専用: true
• inputs: オブジェクト Inputs
  タイトル: Inputs

  JSONまたはYAML構文を使用して入力を入力します。構文例は、ドキュメントを参照してください。
• kind: 文字列
  タイトル: Kind

  読取り専用: true
• kubernetes: 文字列
  タイトル: Kubernetes

  読取り専用: true
• managed: 文字列
  タイトル: Managed

  読取り専用: true
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• name(必須): 文字列
  タイトル: Name

  最小長: 1

  最大長: 512
• organization: 整数
  タイトル: Organization
• related: 文字列
  タイトル: Related

  読取り専用: true
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• type: 文字列
  タイトル: Type

  読取り専用: true
• url: 文字列
  タイトル: Url

  読取り専用: true

{
    "properties":{
        "cloud":{
            "readOnly":true,
            "title":"Cloud",
            "type":"string"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential_type":{
            "description":"Specify the type of credential you want to create. Refer to the documentation for details on each type.",
            "title":"Credential Type",
            "type":"integer"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inputs":{
            "description":"Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.",
            "title":"Inputs",
            "type":"object"
        },
        "kind":{
            "readOnly":true,
            "title":"Kind",
            "type":"string"
        },
        "kubernetes":{
            "readOnly":true,
            "title":"Kubernetes",
            "type":"string"
        },
        "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
        },
        "organization":{
            "title":"Organization",
            "type":"integer",
            "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",
        "credential_type"
    ],
    "type":"object"
}

ネストされたスキーマ : Inputs

型: object

タイトル: Inputs

JSONまたはYAML構文を使用して入力を入力します。構文例は、ドキュメントを参照してください。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

本文()

ルート・スキーマ : Credential

型: object

ソースを表示

• cloud: 文字列
  タイトル: Cloud

  読取り専用: true
• created: 文字列
  タイトル: Created

  読取り専用: true
• credential_type(必須): 整数
  タイトル: Credential Type

  作成する資格証明のタイプを指定します。各タイプの詳細は、ドキュメントを参照してください。
• description: 文字列
  タイトル: Description
• id: 整数
  タイトル: ID

  読取り専用: true
• inputs: オブジェクト Inputs
  タイトル: Inputs

  JSONまたはYAML構文を使用して入力を入力します。構文例は、ドキュメントを参照してください。
• kind: 文字列
  タイトル: Kind

  読取り専用: true
• kubernetes: 文字列
  タイトル: Kubernetes

  読取り専用: true
• managed: 文字列
  タイトル: Managed

  読取り専用: true
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• name(必須): 文字列
  タイトル: Name

  最小長: 1

  最大長: 512
• organization: 整数
  タイトル: Organization
• related: 文字列
  タイトル: Related

  読取り専用: true
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• type: 文字列
  タイトル: Type

  読取り専用: true
• url: 文字列
  タイトル: Url

  読取り専用: true

{
    "properties":{
        "cloud":{
            "readOnly":true,
            "title":"Cloud",
            "type":"string"
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential_type":{
            "description":"Specify the type of credential you want to create. Refer to the documentation for details on each type.",
            "title":"Credential Type",
            "type":"integer"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inputs":{
            "description":"Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.",
            "title":"Inputs",
            "type":"object"
        },
        "kind":{
            "readOnly":true,
            "title":"Kind",
            "type":"string"
        },
        "kubernetes":{
            "readOnly":true,
            "title":"Kubernetes",
            "type":"string"
        },
        "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
        },
        "organization":{
            "title":"Organization",
            "type":"integer",
            "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",
        "credential_type"
    ],
    "type":"object"
}

ネストされたスキーマ : Inputs

型: object

タイトル: Inputs

JSONまたはYAML構文を使用して入力を入力します。構文例は、ドキュメントを参照してください。

先頭に戻る