Delinea · Schema

FolderModel

Describes the properties of a secret folder

Privileged Access ManagementPAMSecrets ManagementIdentity SecurityDevOpsCybersecurity

Properties

Name	Type	Description
childFolders	array	List of folders within this folder
folderName	string	The name of the folder.
folderPath	string	The path of all folders and subfolders beginning at the root anterminating at this folder.
folderTypeId	integer	The icon to display for the folder. Depricated in latest UI. Use 1 when setting this value.
id	integer	Folder ID
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.
secretTemplates	array	List of templates that may be used to create secrets in this 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/FolderModel",
  "title": "FolderModel",
  "description": "Describes the properties of a secret folder",
  "properties": {
    "childFolders": {
      "description": "List of folders within this folder",
      "items": {
        "$ref": "#/components/schemas/IFolderModel"
      },
      "type": "array"
    },
    "folderName": {
      "description": "The name of the folder.",
      "type": "string"
    },
    "folderPath": {
      "description": "The path of all folders and subfolders beginning at the root anterminating at this 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"
    },
    "id": {
      "description": "Folder ID",
      "type": "integer",
      "format": "int32"
    },
    "inheritPermissions": {
      "description": "Whether the folder should inherit permissions from its parent (default: true)",
      "type": "boolean"
    },
    "inheritSecretPolicy": {
      "description": "Whether the folder should inherit the secret policy.  Defaults to true unless creating a root folder.",
      "type": "boolean"
    },
    "parentFolderId": {
      "description": "The ID of this folder's parent folder.",
      "type": "integer",
      "format": "int32"
    },
    "secretPolicyId": {
      "description": "The id of the Secret Policy that sets security and other settings on secrets contained within the folder.",
      "type": "integer",
      "format": "int32"
    },
    "secretTemplates": {
      "description": "List of templates that may be used to create secrets in this folder",
      "items": {
        "$ref": "#/components/schemas/SecretTemplateSummary"
      },
      "type": "array"
    }
  },
  "type": "object"
}