Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

Schema

UpdateSecretBody

Type: object

UpdateSecretRequest replaces secret material. service_type must be empty for custom material (server-assigned)
All constraints apply
serviceType

Type: string

service_type identifies the consuming service.
All schema constraints and annotations
{
  "description": "service_type identifies the consuming service.",
  "type": "string"
}
All schema constraints and annotations
{
  "properties": {
    "serviceType": {
      "description": "service_type identifies the consuming service.",
      "type": "string"
    }
  }
}
Exactly one alternative must match

Type: object

custom · required

Schema: CustomSecretMaterial

custom stores an opaque value with caller-authored injection metadata. UpdateSecretRequest.service_type is server-assigned for custom material; leave it empty.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/CustomSecretMaterial",
  "description": "custom stores an opaque value with caller-authored injection metadata.\nUpdateSecretRequest.service_type is server-assigned for custom\nmaterial; leave it empty."
}
All schema constraints and annotations
{
  "properties": {
    "custom": {
      "$ref": "#/components/schemas/CustomSecretMaterial",
      "description": "custom stores an opaque value with caller-authored injection metadata.\nUpdateSecretRequest.service_type is server-assigned for custom\nmaterial; leave it empty."
    }
  },
  "required": [
    "custom"
  ],
  "title": "custom",
  "type": "object"
}

Type: object

oauth · required

Schema: OAuthRefreshMaterial

oauth stores OAuth refresh material.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/OAuthRefreshMaterial",
  "description": "oauth stores OAuth refresh material."
}
All schema constraints and annotations
{
  "properties": {
    "oauth": {
      "$ref": "#/components/schemas/OAuthRefreshMaterial",
      "description": "oauth stores OAuth refresh material."
    }
  },
  "required": [
    "oauth"
  ],
  "title": "oauth",
  "type": "object"
}

Type: object

token · required

Schema: TokenSecretMaterial

token stores opaque token material.
All schema constraints and annotations
{
  "$ref": "#/components/schemas/TokenSecretMaterial",
  "description": "token stores opaque token material."
}
All schema constraints and annotations
{
  "properties": {
    "token": {
      "$ref": "#/components/schemas/TokenSecretMaterial",
      "description": "token stores opaque token material."
    }
  },
  "required": [
    "token"
  ],
  "title": "token",
  "type": "object"
}
All schema constraints and annotations
{
  "oneOf": [
    {
      "properties": {
        "custom": {
          "$ref": "#/components/schemas/CustomSecretMaterial",
          "description": "custom stores an opaque value with caller-authored injection metadata.\nUpdateSecretRequest.service_type is server-assigned for custom\nmaterial; leave it empty."
        }
      },
      "required": [
        "custom"
      ],
      "title": "custom",
      "type": "object"
    },
    {
      "properties": {
        "oauth": {
          "$ref": "#/components/schemas/OAuthRefreshMaterial",
          "description": "oauth stores OAuth refresh material."
        }
      },
      "required": [
        "oauth"
      ],
      "title": "oauth",
      "type": "object"
    },
    {
      "properties": {
        "token": {
          "$ref": "#/components/schemas/TokenSecretMaterial",
          "description": "token stores opaque token material."
        }
      },
      "required": [
        "token"
      ],
      "title": "token",
      "type": "object"
    }
  ]
}
All schema constraints and annotations
{
  "allOf": [
    {
      "properties": {
        "serviceType": {
          "description": "service_type identifies the consuming service.",
          "type": "string"
        }
      }
    },
    {
      "oneOf": [
        {
          "properties": {
            "custom": {
              "$ref": "#/components/schemas/CustomSecretMaterial",
              "description": "custom stores an opaque value with caller-authored injection metadata.\nUpdateSecretRequest.service_type is server-assigned for custom\nmaterial; leave it empty."
            }
          },
          "required": [
            "custom"
          ],
          "title": "custom",
          "type": "object"
        },
        {
          "properties": {
            "oauth": {
              "$ref": "#/components/schemas/OAuthRefreshMaterial",
              "description": "oauth stores OAuth refresh material."
            }
          },
          "required": [
            "oauth"
          ],
          "title": "oauth",
          "type": "object"
        },
        {
          "properties": {
            "token": {
              "$ref": "#/components/schemas/TokenSecretMaterial",
              "description": "token stores opaque token material."
            }
          },
          "required": [
            "token"
          ],
          "title": "token",
          "type": "object"
        }
      ]
    }
  ],
  "description": "UpdateSecretRequest replaces secret material.\nservice_type must be empty for custom material (server-assigned)",
  "title": "UpdateSecretRequest",
  "type": "object",
  "unevaluatedProperties": false
}