SecretItem

The secret item containing secret metadata.

CertificatesCloud SecurityCryptographyKey ManagementSecrets ManagementSecurity

Properties

Name	Type	Description
id	string	Secret identifier.
attributes	object
tags	object	Application specific metadata in the form of key-value pairs.
contentType	string	Type of the secret value such as a password.
managed	boolean	True if the secret's lifetime is managed by key vault.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SecretItem",
  "title": "SecretItem",
  "type": "object",
  "description": "The secret item containing secret metadata.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Secret identifier.",
      "example": "abc123"
    },
    "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"
    },
    "contentType": {
      "type": "string",
      "description": "Type of the secret value such as a password.",
      "example": "example_value"
    },
    "managed": {
      "type": "boolean",
      "description": "True if the secret's lifetime is managed by key vault.",
      "readOnly": true,
      "example": true
    }
  }
}