BeyondTrust · Schema

SecretWithValue

A secret including its sensitive value.

AccessAccess ManagementComplianceCredentialsPrivileged AccessSecuritySecretsZero Trust

Properties

Name Type Description
id string Unique identifier.
title string Secret title.
type string Secret type.
password string Password value (for Password type secrets).
text string Text value (for Text type secrets).
folderName string Folder name.
created string Creation timestamp.
View JSON Schema on GitHub

JSON Schema

beyondtrust-secret-with-value-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/beyondtrust/refs/heads/main/json-schema/beyondtrust-secret-with-value-schema.json",
  "title": "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": "string",
      "format": "date-time",
      "description": "Creation timestamp.",
      "example": "2025-01-15T00:00:00Z"
    }
  }
}