BeyondTrust · JSON Structure

Beyondtrust Secret Structure

A secret stored in BeyondTrust Secrets Safe.

Type: object Properties: 7
AccessAccess ManagementComplianceCredentialsPrivileged AccessSecuritySecretsZero Trust

Secret is a JSON Structure definition published by BeyondTrust, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id title description type folderName created lastModified

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/beyondtrust/refs/heads/main/json-structure/beyondtrust-secret-structure.json",
  "name": "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": "datetime",
      "description": "When the secret was created.",
      "example": "2025-01-15T00:00:00Z"
    },
    "lastModified": {
      "type": "datetime",
      "description": "When the secret was last modified.",
      "example": "2026-04-01T00:00:00Z"
    }
  }
}