BeyondTrust · JSON Structure

Beyondtrust Secret With Value Structure

A secret including its sensitive value.

Type: object Properties: 7
AccessAccess ManagementComplianceCredentialsPrivileged AccessSecuritySecretsZero Trust

SecretWithValue 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 type password text folderName created

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-with-value-structure.json",
  "name": "SecretWithValue",
  "description": "A secret including its sensitive value.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier.",
      "example": "secret-a1b2c3"
    },
    "title": {
      "type": "string",
      "description": "Secret title.",
      "example": "database-credentials"
    },
    "type": {
      "type": "string",
      "description": "Secret type.",
      "example": "Password"
    },
    "password": {
      "type": "string",
      "nullable": true,
      "description": "Password value (for Password type secrets).",
      "example": "Xk2!mP9@nQ7#rT5"
    },
    "text": {
      "type": "string",
      "nullable": true,
      "description": "Text value (for Text type secrets).",
      "example": null
    },
    "folderName": {
      "type": "string",
      "nullable": true,
      "description": "Folder name.",
      "example": "Production"
    },
    "created": {
      "type": "datetime",
      "description": "Creation timestamp.",
      "example": "2025-01-15T00:00:00Z"
    }
  }
}