Delinea · Schema

FolderCreateArgs

Available options for creating a secret folder

Privileged Access ManagementPAMSecrets ManagementIdentity SecurityDevOpsCybersecurity

Properties

Name	Type	Description
folderName	string	The name of the folder.
folderTypeId	integer	The icon to display for the folder. Depricated in latest UI. Use 1 when setting this value.
inheritPermissions	boolean	Whether the folder should inherit permissions from its parent (default: true)
inheritSecretPolicy	boolean	Whether the folder should inherit the secret policy. Defaults to true unless creating a root folder.
parentFolderId	integer	The id of this folder's parent folder.
secretPolicyId	integer	The id of the Secret Policy that sets security and other settings on secrets contained within the folder.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://docs.delinea.com/online-help/secret-server/api-scripting/rest-api/schemas/FolderCreateArgs",
  "title": "FolderCreateArgs",
  "description": "Available options for creating a secret folder",
  "required": [
    "folderName",
    "folderTypeId",
    "parentFolderId"
  ],
  "properties": {
    "folderName": {
      "description": "The name of the folder.",
      "type": "string"
    },
    "folderTypeId": {
      "description": "The icon to display for the folder. Depricated in latest UI. Use 1 when setting this value.",
      "type": "integer",
      "format": "int32",
      "maximum": 3,
      "minimum": 1
    },
    "inheritPermissions": {
      "description": "Whether the folder should inherit permissions from its parent (default: true)",
      "type": "boolean",
      "nullable": true
    },
    "inheritSecretPolicy": {
      "description": "Whether the folder should inherit the secret policy.  Defaults to true unless creating a root folder.",
      "type": "boolean",
      "nullable": true
    },
    "parentFolderId": {
      "description": "The id of this folder's parent folder.",
      "type": "integer",
      "format": "int32",
      "minimum": -1
    },
    "secretPolicyId": {
      "description": "The id of the Secret Policy that sets security and other settings on secrets contained within the folder.",
      "type": "integer",
      "format": "int32"
    }
  },
  "type": "object"
}