SecretBundle

A secret consisting of a value, id and its attributes.

CertificatesCloud SecurityCryptographyKey ManagementSecrets ManagementSecurity

Properties

Name	Type	Description
value	string	The secret value.
id	string	The secret id.
contentType	string	The content type of the secret.
attributes	object
tags	object	Application specific metadata in the form of key-value pairs.
kid	string	If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate.
managed	boolean	True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SecretBundle",
  "title": "SecretBundle",
  "type": "object",
  "description": "A secret consisting of a value, id and its attributes.",
  "properties": {
    "value": {
      "type": "string",
      "description": "The secret value.",
      "example": "example_value"
    },
    "id": {
      "type": "string",
      "description": "The secret id.",
      "example": "abc123"
    },
    "contentType": {
      "type": "string",
      "description": "The content type of the secret.",
      "example": "example_value"
    },
    "attributes": {
      "$ref": "#/components/schemas/SecretAttributes"
    },
    "tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Application specific metadata in the form of key-value pairs.",
      "example": "example_value"
    },
    "kid": {
      "type": "string",
      "description": "If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate.",
      "readOnly": true,
      "example": "500123"
    },
    "managed": {
      "type": "boolean",
      "description": "True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true.",
      "readOnly": true,
      "example": true
    }
  }
}