Dapr · Schema

Dapr Secret

Represents a secret retrieved from a Dapr secret store. Secrets are returned as key/value string pairs from pluggable stores such as Hashicorp Vault, AWS Secrets Manager, Azure Key Vault, GCP Secret Manager, and Kubernetes Secrets.

Distributed SystemsMicroservicesPlatformPub/SubState ManagementWorkflows

Properties

Name Type Description
name string The name of the secret.
store string The name of the secret store component.
values object The secret key/value pairs.
metadata object Optional metadata for the secret request.
View JSON Schema on GitHub

JSON Schema

secret.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-evangelist/dapr/blob/main/json-schema/secret.json",
  "title": "Dapr Secret",
  "description": "Represents a secret retrieved from a Dapr secret store. Secrets are returned as key/value string pairs from pluggable stores such as Hashicorp Vault, AWS Secrets Manager, Azure Key Vault, GCP Secret Manager, and Kubernetes Secrets.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the secret."
    },
    "store": {
      "type": "string",
      "description": "The name of the secret store component."
    },
    "values": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "The secret key/value pairs."
    },
    "metadata": {
      "type": "object",
      "properties": {
        "version_id": {
          "type": "string",
          "description": "Version identifier for the secret."
        },
        "version_stage": {
          "type": "string",
          "description": "Version stage for the secret (e.g., AWSCURRENT)."
        },
        "namespace": {
          "type": "string",
          "description": "Kubernetes namespace for the secret."
        }
      },
      "description": "Optional metadata for the secret request."
    }
  }
}