Data Types


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


"path": String,
"scope": String


"path": "/users/user-xyz",
"scope": "Children"



Absolute path to a file or folder. Begins with a /. Should not end with a /.

Example: "/users/user-xyz"

Type: String

Min Length: 1

Max Length: 512

Required: Yes


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: