Resource URL: /platform/<<version=6>>/protocols/smb/shares

    Overview: This resource applies the standard collection pattern to SMB
              shares.

     Methods: GET, POST, DELETE

********************************************************************************

Method GET: List all shares.

       URL: GET /platform/<<version=6>>/protocols/smb/shares

Query arguments:
            sort=<enum> Where <enum> is one of id, name, path, description.
                        Order results by this field. Default is id.
          zone=<string> Zone which contains this share.
        resume=<string> Continue returning results from previous call using
                        this token (token should come from the previous call,
                        resume cannot be used with other options).
resolve_names=<boolean> If true, resolve group and user names in personas.
        limit=<integer> Return no more than this many results at once (see
                        resume).
           scope=<enum> Where <enum> is one of user, default, effective.  If
                        specified as "effective" or not specified, all fields
                        are returned.  If specified as "user", only fields with
                        non-default values are shown.  If specified as
                        "default", the original values are returned.
             dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the
                        sort.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "shares": {
          "minItems": 0, 
          "items": {
            "required": true, 
            "type": "object", 
            "properties": {
              "file_create_mode": {
                "minimum": 0, 
                "type": "integer", 
                "description": "File create mode bits.", 
                "maximum": 511
              }, 
              "ntfs_acl_support": {
                "type": "boolean", 
                "description": "Support NTFS ACLs on files and directories."
              }, 
              "file_filtering_enabled": {
                "type": "boolean", 
                "description": "Enables file filtering on this zone."
              }, 
              "directory_create_mask": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Directory create mask bits.", 
                "maximum": 511
              }, 
              "inheritable_path_acl": {
                "type": "boolean", 
                "description": "Set the inheritable ACL on the share path."
              }, 
              "ca_write_integrity": {
                "enum": [
                  "none", 
                  "write-read-coherent", 
                  "full"
                ], 
                "type": "string", 
                "description": "Specify the level of write-integrity on continuously available shares."
              }, 
              "file_create_mask": {
                "minimum": 0, 
                "type": "integer", 
                "description": "File create mask bits.", 
                "maximum": 511
              }, 
              "path": {
                "description": "Path of share within /ifs.", 
                "minLength": 1, 
                "required": true, 
                "pattern": "^$|.", 
                "maxLength": 511, 
                "type": [
                  "null", 
                  "string"
                ]
              }, 
              "access_based_enumeration_root_only": {
                "type": "boolean", 
                "description": "Access-based enumeration on only the root directory of the share."
              }, 
              "allow_variable_expansion": {
                "type": "boolean", 
                "description": "Allow automatic expansion of variables for home directories."
              }, 
              "id": {
                "description": "Share ID.", 
                "minLength": 0, 
                "required": true, 
                "pattern": "^$|.", 
                "maxLength": 511, 
                "type": [
                  "null", 
                  "string"
                ]
              }, 
              "hide_dot_files": {
                "type": "boolean", 
                "description": "Hide files and directories that begin with a period '.'."
              }, 
              "create_permissions": {
                "enum": [
                  "default acl", 
                  "inherit mode bits", 
                  "use create mask and mode"
                ], 
                "type": "string", 
                "description": "Create permissions for new files and directories in share."
              }, 
              "strict_locking": {
                "type": "boolean", 
                "description": "Specifies whether byte range locks contend against SMB I/O."
              }, 
              "mangle_map": {
                "description": "Character mangle map.", 
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "pattern": "^$|.", 
                  "maxLength": 511
                }, 
                "maxItems": 4294967295, 
                "uniqueItems": true, 
                "type": "array"
              }, 
              "zid": {
                "required": true, 
                "minimum": 0, 
                "type": "integer", 
                "description": "Numeric ID of the access zone which contains this SMB share", 
                "maximum": 4294967295
              }, 
              "file_filter_type": {
                "enum": [
                  "deny", 
                  "allow"
                ], 
                "type": "string", 
                "description": "Specifies if filter list is for deny or allow. Default is deny."
              }, 
              "file_filter_extensions": {
                "description": "Specifies the list of file extensions.", 
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "pattern": "^$|.", 
                  "maxLength": 511
                }, 
                "maxItems": 4294967295, 
                "uniqueItems": true, 
                "type": "array"
              }, 
              "browsable": {
                "type": "boolean", 
                "description": "Share is visible in net view and the browse list."
              }, 
              "description": {
                "minLength": 0, 
                "type": "string", 
                "pattern": "^$|.", 
                "description": "Description for this SMB share.", 
                "maxLength": 511
              }, 
              "auto_create_directory": {
                "type": "boolean", 
                "description": "Automatically create home directories."
              }, 
              "continuously_available": {
                "type": "boolean", 
                "description": "Specify if persistent opens are allowed on the share."
              }, 
              "directory_create_mode": {
                "minimum": 0, 
                "type": "integer", 
                "description": "Directory create mode bits.", 
                "maximum": 511
              }, 
              "allow_delete_readonly": {
                "type": "boolean", 
                "description": "Allow deletion of read-only files in the share."
              }, 
              "ca_timeout": {
                "minimum": 2, 
                "type": "integer", 
                "description": "Persistent open timeout for the share.", 
                "maximum": 6000
              }, 
              "access_based_enumeration": {
                "type": "boolean", 
                "description": "Only enumerate files and folders the requesting user has access to."
              }, 
              "allow_execute_always": {
                "type": "boolean", 
                "description": "Allows users to execute files they have read rights for."
              }, 
              "csc_policy": {
                "enum": [
                  "manual", 
                  "documents", 
                  "programs", 
                  "none"
                ], 
                "type": "string", 
                "description": "Client-side caching policy for the shares."
              }, 
              "run_as_root": {
                "description": "Allow account to run as root.", 
                "minItems": 0, 
                "items": {
                  "type": "object", 
                  "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                  "properties": {
                    "type": {
                      "enum": [
                        "user", 
                        "group", 
                        "wellknown"
                      ], 
                      "type": "string", 
                      "description": "Specifies the type of persona, which must be combined with a name."
                    }, 
                    "id": {
                      "minLength": 0, 
                      "type": "string", 
                      "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                      "maxLength": 261
                    }, 
                    "name": {
                      "minLength": 0, 
                      "type": "string", 
                      "description": "Specifies the persona name, which must be combined with a type.", 
                      "maxLength": 255
                    }
                  }
                }, 
                "maxItems": 4294967295, 
                "uniqueItems": true, 
                "type": "array"
              }, 
              "permissions": {
                "description": "Specifies an ordered list of permission modifications.", 
                "minItems": 0, 
                "items": {
                  "type": "object", 
                  "description": "Specifies properties for an Access Control Entry.", 
                  "properties": {
                    "permission_type": {
                      "enum": [
                        "allow", 
                        "deny"
                      ], 
                      "type": "string", 
                      "description": "Determines whether the permission is allowed or denied.", 
                      "required": true
                    }, 
                    "trustee": {
                      "required": true, 
                      "type": "object", 
                      "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                      "properties": {
                        "type": {
                          "enum": [
                            "user", 
                            "group", 
                            "wellknown"
                          ], 
                          "type": "string", 
                          "description": "Specifies the type of persona, which must be combined with a name."
                        }, 
                        "id": {
                          "minLength": 0, 
                          "type": "string", 
                          "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                          "maxLength": 261
                        }, 
                        "name": {
                          "minLength": 0, 
                          "type": "string", 
                          "description": "Specifies the persona name, which must be combined with a type.", 
                          "maxLength": 255
                        }
                      }
                    }, 
                    "permission": {
                      "enum": [
                        "full", 
                        "change", 
                        "read"
                      ], 
                      "type": "string", 
                      "description": "Specifies the file system rights that are allowed or denied.", 
                      "required": true
                    }
                  }
                }, 
                "maxItems": 4294967295, 
                "uniqueItems": true, 
                "type": "array"
              }, 
              "name": {
                "description": "Share name.", 
                "minLength": 1, 
                "required": true, 
                "pattern": "^$|.", 
                "maxLength": 511, 
                "type": [
                  "null", 
                  "string"
                ]
              }, 
              "smb3_encryption_enabled": {
                "type": "boolean", 
                "description": "Enables SMB3 encryption for the share."
              }, 
              "host_acl": {
                "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", 
                "minItems": 0, 
                "items": {
                  "minLength": 1, 
                  "type": "string", 
                  "pattern": "^$|.", 
                  "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '<IP-range|subnet|fqdn>].", 
                  "maxLength": 511
                }, 
                "maxItems": 4294967295, 
                "uniqueItems": true, 
                "type": "array"
              }, 
              "change_notify": {
                "enum": [
                  "all", 
                  "norecurse", 
                  "none"
                ], 
                "type": "string", 
                "description": "Level of change notification alerts on the share."
              }, 
              "mangle_byte_start": {
                "minimum": 256, 
                "type": "integer", 
                "description": "Specifies the wchar_t starting point for automatic byte mangling.", 
                "maximum": 65535
              }, 
              "impersonate_user": {
                "minLength": 0, 
                "type": "string", 
                "pattern": "^$|.", 
                "description": "User account to be used as guest account.", 
                "maxLength": 511
              }, 
              "impersonate_guest": {
                "enum": [
                  "always", 
                  "bad user", 
                  "never"
                ], 
                "type": "string", 
                "description": "Specify the condition in which user access is done as the guest account."
              }, 
              "oplocks": {
                "type": "boolean", 
                "description": "Support oplocks."
              }, 
              "strict_flush": {
                "type": "boolean", 
                "description": "Handle SMB flush operations."
              }, 
              "strict_ca_lockout": {
                "type": "boolean", 
                "description": "Specifies if persistent opens would do strict lockout on the share."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "digest": {
          "minLength": 0, 
          "type": "string", 
          "pattern": "^$|.", 
          "description": "An identifier for a set of shares.", 
          "maxLength": 256
        }, 
        "resume": {
          "minLength": 0, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
        }
      }
    }
  ]
}

********************************************************************************

Method POST: Create a new share.

        URL: POST /platform/<<version=6>>/protocols/smb/shares

Query arguments:
zone=<string> Specifies which access zone or zones to use.

POST request body schema:
{
  "type": [
    {
      "required": true, 
      "type": "object", 
      "properties": {
        "file_create_mode": {
          "minimum": 0, 
          "type": "integer", 
          "description": "File create mode bits.", 
          "maximum": 511
        }, 
        "ntfs_acl_support": {
          "type": "boolean", 
          "description": "Support NTFS ACLs on files and directories."
        }, 
        "file_filtering_enabled": {
          "type": "boolean", 
          "description": "Enables file filtering on this zone."
        }, 
        "directory_create_mask": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Directory create mask bits.", 
          "maximum": 511
        }, 
        "inheritable_path_acl": {
          "type": "boolean", 
          "description": "Set the inheritable ACL on the share path."
        }, 
        "ca_write_integrity": {
          "enum": [
            "none", 
            "write-read-coherent", 
            "full"
          ], 
          "type": "string", 
          "description": "Specify the level of write-integrity on continuously available shares."
        }, 
        "file_create_mask": {
          "minimum": 0, 
          "type": "integer", 
          "description": "File create mask bits.", 
          "maximum": 511
        }, 
        "path": {
          "description": "Path of share within /ifs.", 
          "minLength": 1, 
          "required": true, 
          "pattern": "^$|.", 
          "maxLength": 511, 
          "type": "string"
        }, 
        "access_based_enumeration_root_only": {
          "type": "boolean", 
          "description": "Access-based enumeration on only the root directory of the share."
        }, 
        "allow_variable_expansion": {
          "type": "boolean", 
          "description": "Allow automatic expansion of variables for home directories."
        }, 
        "hide_dot_files": {
          "type": "boolean", 
          "description": "Hide files and directories that begin with a period '.'."
        }, 
        "create_permissions": {
          "enum": [
            "default acl", 
            "inherit mode bits", 
            "use create mask and mode"
          ], 
          "type": "string", 
          "description": "Create permissions for new files and directories in share."
        }, 
        "strict_locking": {
          "type": "boolean", 
          "description": "Specifies whether byte range locks contend against SMB I/O."
        }, 
        "zone": {
          "minLength": 1, 
          "type": "string", 
          "pattern": "^$|.", 
          "description": "Name of the access zone to which to move this SMB share", 
          "maxLength": 511
        }, 
        "mangle_map": {
          "description": "Character mangle map.", 
          "minItems": 0, 
          "items": {
            "minLength": 1, 
            "type": "string", 
            "pattern": "^$|.", 
            "maxLength": 511
          }, 
          "maxItems": 4294967295, 
          "uniqueItems": true, 
          "type": "array"
        }, 
        "file_filter_type": {
          "enum": [
            "deny", 
            "allow"
          ], 
          "type": "string", 
          "description": "Specifies if filter list is for deny or allow. Default is deny."
        }, 
        "file_filter_extensions": {
          "description": "Specifies the list of file extensions.", 
          "minItems": 0, 
          "items": {
            "minLength": 1, 
            "type": "string", 
            "pattern": "^$|.", 
            "maxLength": 511
          }, 
          "maxItems": 4294967295, 
          "uniqueItems": true, 
          "type": "array"
        }, 
        "browsable": {
          "type": "boolean", 
          "description": "Share is visible in net view and the browse list."
        }, 
        "description": {
          "minLength": 0, 
          "type": "string", 
          "pattern": "^$|.", 
          "description": "Description for this SMB share.", 
          "maxLength": 511
        }, 
        "auto_create_directory": {
          "type": "boolean", 
          "description": "Automatically create home directories."
        }, 
        "continuously_available": {
          "type": "boolean", 
          "description": "Specify if persistent opens are allowed on the share."
        }, 
        "directory_create_mode": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Directory create mode bits.", 
          "maximum": 511
        }, 
        "allow_delete_readonly": {
          "type": "boolean", 
          "description": "Allow deletion of read-only files in the share."
        }, 
        "ca_timeout": {
          "minimum": 2, 
          "type": "integer", 
          "description": "Persistent open timeout for the share.", 
          "maximum": 6000
        }, 
        "access_based_enumeration": {
          "type": "boolean", 
          "description": "Only enumerate files and folders the requesting user has access to."
        }, 
        "allow_execute_always": {
          "type": "boolean", 
          "description": "Allows users to execute files they have read rights for."
        }, 
        "csc_policy": {
          "enum": [
            "manual", 
            "documents", 
            "programs", 
            "none"
          ], 
          "type": "string", 
          "description": "Client-side caching policy for the shares."
        }, 
        "run_as_root": {
          "description": "Allow account to run as root.", 
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
            "properties": {
              "type": {
                "enum": [
                  "user", 
                  "group", 
                  "wellknown"
                ], 
                "type": "string", 
                "description": "Specifies the type of persona, which must be combined with a name."
              }, 
              "id": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                "maxLength": 261
              }, 
              "name": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the persona name, which must be combined with a type.", 
                "maxLength": 255
              }
            }
          }, 
          "maxItems": 4294967295, 
          "uniqueItems": true, 
          "type": "array"
        }, 
        "permissions": {
          "description": "Specifies an ordered list of permission modifications.", 
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Specifies properties for an Access Control Entry.", 
            "properties": {
              "permission_type": {
                "enum": [
                  "allow", 
                  "deny"
                ], 
                "type": "string", 
                "description": "Determines whether the permission is allowed or denied.", 
                "required": true
              }, 
              "trustee": {
                "required": true, 
                "type": "object", 
                "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                "properties": {
                  "type": {
                    "enum": [
                      "user", 
                      "group", 
                      "wellknown"
                    ], 
                    "type": "string", 
                    "description": "Specifies the type of persona, which must be combined with a name."
                  }, 
                  "id": {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                    "maxLength": 261
                  }, 
                  "name": {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the persona name, which must be combined with a type.", 
                    "maxLength": 255
                  }
                }
              }, 
              "permission": {
                "enum": [
                  "full", 
                  "change", 
                  "read"
                ], 
                "type": "string", 
                "description": "Specifies the file system rights that are allowed or denied.", 
                "required": true
              }
            }
          }, 
          "maxItems": 4294967295, 
          "uniqueItems": true, 
          "type": "array"
        }, 
        "name": {
          "description": "Share name.", 
          "minLength": 1, 
          "required": true, 
          "pattern": "^$|.", 
          "maxLength": 511, 
          "type": "string"
        }, 
        "smb3_encryption_enabled": {
          "type": "boolean", 
          "description": "Enables SMB3 encryption for the share."
        }, 
        "host_acl": {
          "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", 
          "minItems": 0, 
          "items": {
            "minLength": 1, 
            "type": "string", 
            "pattern": "^$|.", 
            "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '<IP-range|subnet|fqdn>].", 
            "maxLength": 511
          }, 
          "maxItems": 4294967295, 
          "uniqueItems": true, 
          "type": "array"
        }, 
        "change_notify": {
          "enum": [
            "all", 
            "norecurse", 
            "none"
          ], 
          "type": "string", 
          "description": "Level of change notification alerts on the share."
        }, 
        "mangle_byte_start": {
          "minimum": 256, 
          "type": "integer", 
          "description": "Specifies the wchar_t starting point for automatic byte mangling.", 
          "maximum": 65535
        }, 
        "impersonate_user": {
          "minLength": 0, 
          "type": "string", 
          "pattern": "^$|.", 
          "description": "User account to be used as guest account.", 
          "maxLength": 511
        }, 
        "create_path": {
          "type": "boolean", 
          "description": "Create path if does not exist."
        }, 
        "impersonate_guest": {
          "enum": [
            "always", 
            "bad user", 
            "never"
          ], 
          "type": "string", 
          "description": "Specify the condition in which user access is done as the guest account."
        }, 
        "oplocks": {
          "type": "boolean", 
          "description": "Support oplocks."
        }, 
        "strict_flush": {
          "type": "boolean", 
          "description": "Handle SMB flush operations."
        }, 
        "strict_ca_lockout": {
          "type": "boolean", 
          "description": "Specifies if persistent opens would do strict lockout on the share."
        }
      }
    }, 
    {
      "minItems": 0, 
      "items": {
        "required": true, 
        "type": "object", 
        "properties": {
          "file_create_mode": {
            "minimum": 0, 
            "type": "integer", 
            "description": "File create mode bits.", 
            "maximum": 511
          }, 
          "ntfs_acl_support": {
            "type": "boolean", 
            "description": "Support NTFS ACLs on files and directories."
          }, 
          "file_filtering_enabled": {
            "type": "boolean", 
            "description": "Enables file filtering on this zone."
          }, 
          "directory_create_mask": {
            "minimum": 0, 
            "type": "integer", 
            "description": "Directory create mask bits.", 
            "maximum": 511
          }, 
          "inheritable_path_acl": {
            "type": "boolean", 
            "description": "Set the inheritable ACL on the share path."
          }, 
          "ca_write_integrity": {
            "enum": [
              "none", 
              "write-read-coherent", 
              "full"
            ], 
            "type": "string", 
            "description": "Specify the level of write-integrity on continuously available shares."
          }, 
          "file_create_mask": {
            "minimum": 0, 
            "type": "integer", 
            "description": "File create mask bits.", 
            "maximum": 511
          }, 
          "path": {
            "description": "Path of share within /ifs.", 
            "minLength": 1, 
            "required": true, 
            "pattern": "^$|.", 
            "maxLength": 511, 
            "type": "string"
          }, 
          "access_based_enumeration_root_only": {
            "type": "boolean", 
            "description": "Access-based enumeration on only the root directory of the share."
          }, 
          "allow_variable_expansion": {
            "type": "boolean", 
            "description": "Allow automatic expansion of variables for home directories."
          }, 
          "hide_dot_files": {
            "type": "boolean", 
            "description": "Hide files and directories that begin with a period '.'."
          }, 
          "create_permissions": {
            "enum": [
              "default acl", 
              "inherit mode bits", 
              "use create mask and mode"
            ], 
            "type": "string", 
            "description": "Create permissions for new files and directories in share."
          }, 
          "strict_locking": {
            "type": "boolean", 
            "description": "Specifies whether byte range locks contend against SMB I/O."
          }, 
          "zone": {
            "minLength": 1, 
            "type": "string", 
            "pattern": "^$|.", 
            "description": "Name of the access zone to which to move this SMB share", 
            "maxLength": 511
          }, 
          "mangle_map": {
            "description": "Character mangle map.", 
            "minItems": 0, 
            "items": {
              "minLength": 1, 
              "type": "string", 
              "pattern": "^$|.", 
              "maxLength": 511
            }, 
            "maxItems": 4294967295, 
            "uniqueItems": true, 
            "type": "array"
          }, 
          "file_filter_type": {
            "enum": [
              "deny", 
              "allow"
            ], 
            "type": "string", 
            "description": "Specifies if filter list is for deny or allow. Default is deny."
          }, 
          "file_filter_extensions": {
            "description": "Specifies the list of file extensions.", 
            "minItems": 0, 
            "items": {
              "minLength": 1, 
              "type": "string", 
              "pattern": "^$|.", 
              "maxLength": 511
            }, 
            "maxItems": 4294967295, 
            "uniqueItems": true, 
            "type": "array"
          }, 
          "browsable": {
            "type": "boolean", 
            "description": "Share is visible in net view and the browse list."
          }, 
          "description": {
            "minLength": 0, 
            "type": "string", 
            "pattern": "^$|.", 
            "description": "Description for this SMB share.", 
            "maxLength": 511
          }, 
          "auto_create_directory": {
            "type": "boolean", 
            "description": "Automatically create home directories."
          }, 
          "continuously_available": {
            "type": "boolean", 
            "description": "Specify if persistent opens are allowed on the share."
          }, 
          "directory_create_mode": {
            "minimum": 0, 
            "type": "integer", 
            "description": "Directory create mode bits.", 
            "maximum": 511
          }, 
          "allow_delete_readonly": {
            "type": "boolean", 
            "description": "Allow deletion of read-only files in the share."
          }, 
          "ca_timeout": {
            "minimum": 2, 
            "type": "integer", 
            "description": "Persistent open timeout for the share.", 
            "maximum": 6000
          }, 
          "access_based_enumeration": {
            "type": "boolean", 
            "description": "Only enumerate files and folders the requesting user has access to."
          }, 
          "allow_execute_always": {
            "type": "boolean", 
            "description": "Allows users to execute files they have read rights for."
          }, 
          "csc_policy": {
            "enum": [
              "manual", 
              "documents", 
              "programs", 
              "none"
            ], 
            "type": "string", 
            "description": "Client-side caching policy for the shares."
          }, 
          "run_as_root": {
            "description": "Allow account to run as root.", 
            "minItems": 0, 
            "items": {
              "type": "object", 
              "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
              "properties": {
                "type": {
                  "enum": [
                    "user", 
                    "group", 
                    "wellknown"
                  ], 
                  "type": "string", 
                  "description": "Specifies the type of persona, which must be combined with a name."
                }, 
                "id": {
                  "minLength": 0, 
                  "type": "string", 
                  "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                  "maxLength": 261
                }, 
                "name": {
                  "minLength": 0, 
                  "type": "string", 
                  "description": "Specifies the persona name, which must be combined with a type.", 
                  "maxLength": 255
                }
              }
            }, 
            "maxItems": 4294967295, 
            "uniqueItems": true, 
            "type": "array"
          }, 
          "permissions": {
            "description": "Specifies an ordered list of permission modifications.", 
            "minItems": 0, 
            "items": {
              "type": "object", 
              "description": "Specifies properties for an Access Control Entry.", 
              "properties": {
                "permission_type": {
                  "enum": [
                    "allow", 
                    "deny"
                  ], 
                  "type": "string", 
                  "description": "Determines whether the permission is allowed or denied.", 
                  "required": true
                }, 
                "trustee": {
                  "required": true, 
                  "type": "object", 
                  "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                  "properties": {
                    "type": {
                      "enum": [
                        "user", 
                        "group", 
                        "wellknown"
                      ], 
                      "type": "string", 
                      "description": "Specifies the type of persona, which must be combined with a name."
                    }, 
                    "id": {
                      "minLength": 0, 
                      "type": "string", 
                      "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'.", 
                      "maxLength": 261
                    }, 
                    "name": {
                      "minLength": 0, 
                      "type": "string", 
                      "description": "Specifies the persona name, which must be combined with a type.", 
                      "maxLength": 255
                    }
                  }
                }, 
                "permission": {
                  "enum": [
                    "full", 
                    "change", 
                    "read"
                  ], 
                  "type": "string", 
                  "description": "Specifies the file system rights that are allowed or denied.", 
                  "required": true
                }
              }
            }, 
            "maxItems": 4294967295, 
            "uniqueItems": true, 
            "type": "array"
          }, 
          "name": {
            "description": "Share name.", 
            "minLength": 1, 
            "required": true, 
            "pattern": "^$|.", 
            "maxLength": 511, 
            "type": "string"
          }, 
          "smb3_encryption_enabled": {
            "type": "boolean", 
            "description": "Enables SMB3 encryption for the share."
          }, 
          "host_acl": {
            "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry.", 
            "minItems": 0, 
            "items": {
              "minLength": 1, 
              "type": "string", 
              "pattern": "^$|.", 
              "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '<IP-range|subnet|fqdn>].", 
              "maxLength": 511
            }, 
            "maxItems": 4294967295, 
            "uniqueItems": true, 
            "type": "array"
          }, 
          "change_notify": {
            "enum": [
              "all", 
              "norecurse", 
              "none"
            ], 
            "type": "string", 
            "description": "Level of change notification alerts on the share."
          }, 
          "mangle_byte_start": {
            "minimum": 256, 
            "type": "integer", 
            "description": "Specifies the wchar_t starting point for automatic byte mangling.", 
            "maximum": 65535
          }, 
          "impersonate_user": {
            "minLength": 0, 
            "type": "string", 
            "pattern": "^$|.", 
            "description": "User account to be used as guest account.", 
            "maxLength": 511
          }, 
          "create_path": {
            "type": "boolean", 
            "description": "Create path if does not exist."
          }, 
          "impersonate_guest": {
            "enum": [
              "always", 
              "bad user", 
              "never"
            ], 
            "type": "string", 
            "description": "Specify the condition in which user access is done as the guest account."
          }, 
          "oplocks": {
            "type": "boolean", 
            "description": "Support oplocks."
          }, 
          "strict_flush": {
            "type": "boolean", 
            "description": "Handle SMB flush operations."
          }, 
          "strict_ca_lockout": {
            "type": "boolean", 
            "description": "Specifies if persistent opens would do strict lockout on the share."
          }
        }
      }, 
      "uniqueItems": true, 
      "type": "array", 
      "maxItems": 4294967295
    }
  ], 
  "description": "An array of ids to refer newly created SMB shares."
}

POST response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": [
        {
          "additionalProperties": false, 
          "type": "object", 
          "properties": {
            "id": {
              "description": "ID of created item that can be used to refer to item in the collection-item resource path.", 
              "minLength": 1, 
              "required": true, 
              "pattern": "^$|.", 
              "maxLength": 255, 
              "type": "string"
            }
          }
        }, 
        {
          "minItems": 0, 
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "properties": {
              "id": {
                "description": "ID of created item that can be used to refer to item in the collection-item resource path.", 
                "minLength": 1, 
                "required": true, 
                "pattern": "^$|.", 
                "maxLength": 255, 
                "type": "string"
              }
            }
          }, 
          "uniqueItems": true, 
          "type": "array", 
          "maxItems": 4294967295
        }
      ]
    }
  ]
}

********************************************************************************

Method DELETE: Delete multiple smb shares.

          URL: DELETE /platform/<<version=6>>/protocols/smb/shares

Query arguments:
zone=<string> Specifies which access zone or zones to use.

DELETE request body schema:
{
  "minItems": 1, 
  "items": {
    "minLength": 1, 
    "type": "string", 
    "maxLength": 511
  }, 
  "type": "array", 
  "description": "An array of strings referring to existing SMB shares", 
  "maxItems": 65535
}

There is no JSON response body for this method.
