BeyondTrust · Schema

CreateSecretRequest

Request body for creating a new secret.

AccessAccess ManagementComplianceCredentialsPrivileged AccessSecuritySecretsZero Trust

Properties

Name Type Description
title string Title of the secret.
description string Description of the secret.
type string Type of secret.
password string Password value (for Password type).
text string Text value (for Text type).
folderName string Folder to store the secret in.
View JSON Schema on GitHub

JSON Schema

beyondtrust-create-secret-request-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-create-secret-request-schema.json",
  "title": "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"
  ]
}