Secret

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/beyondtrust/refs/heads/main/json-schema/beyondtrust-secret-schema.json",
  "title": "Secret",
  "description": "A secret stored in BeyondTrust Secrets Safe.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the secret.",
      "example": "secret-a1b2c3"
    },
    "title": {
      "type": "string",
      "description": "Title or name of the secret.",
      "example": "database-credentials"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "description": "Description of the secret.",
      "example": "Production database credentials"
    },
    "type": {
      "type": "string",
      "description": "Type of secret.",
      "enum": [
        "Password",
        "Text",
        "File"
      ],
      "example": "Password"
    },
    "folderName": {
      "type": "string",
      "nullable": true,
      "description": "Folder organizing this secret.",
      "example": "Production"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "When the secret was created.",
      "example": "2025-01-15T00:00:00Z"
    },
    "lastModified": {
      "type": "string",
      "format": "date-time",
      "description": "When the secret was last modified.",
      "example": "2026-04-01T00:00:00Z"
    }
  }
}