BeyondTrust · JSON Structure

Beyondtrust Create Secret Request Structure

Request body for creating a new secret.

Type: object Properties: 6 Required: 2
AccessAccess ManagementComplianceCredentialsPrivileged AccessSecuritySecretsZero Trust

CreateSecretRequest is a JSON Structure definition published by BeyondTrust, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

title description type password text folderName

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-create-secret-request-structure.json",
  "name": "CreateSecretRequest",
  "description": "Request body for creating a new secret.",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Title of the secret.",
      "example": "new-api-key"
    },
    "description": {
      "type": "string",
      "description": "Description of the secret.",
      "example": "API key for production service"
    },
    "type": {
      "type": "string",
      "description": "Type of secret.",
      "enum": [
        "Password",
        "Text",
        "File"
      ],
      "example": "Password"
    },
    "password": {
      "type": "string",
      "description": "Password value (for Password type).",
      "example": "SecurePassword123!"
    },
    "text": {
      "type": "string",
      "description": "Text value (for Text type).",
      "example": "my-secret-text"
    },
    "folderName": {
      "type": "string",
      "description": "Folder to store the secret in.",
      "example": "Production"
    }
  },
  "required": [
    "title",
    "type"
  ]
}