Data Types

PathPattern

Describes which file(s) and/or folder(s) to apply the permissions to.

Structure

{
"path": String,
"scope": String
}

Example

{
"path": "/uploads/file.jpg",
"scope": "Children"
}

Properties

path

Absolute path to a file or folder. Must begin with a /.

Type: String

Min Length: 1

Max Length: 512

Example: "/uploads/file.jpg"

Required: Yes

scope

Specifies the level in the file tree, relative to the path, that these permissions apply.

"This": Permissions apply to the current path only.

"Children": Permissions apply to the children (files and folders) of this path only.

"Grandchildren+": Permissions apply to the grandchildren (files and folders) of this path and their descendants only.

Type: String

Allowed Values: "Children", "Grandchildren+", "This"

Required: Yes

Used by

Was this section helpful? Yes No

You are using an outdated browser.

This website requires a modern web browser -- the latest versions of these browsers are supported: