removeFolderPermissions

Name	Type	Required	Description
companyHandle	xsd:string	Yes	The handle to the company with folders with permissions you want to remove.
folderHandle	xsd:string	Yes	Handle to the folder.
updateChildren	xsd:boolean	Yes	When true: Permissions removal propagates through all folder permission operations. When false: The operation affects the specified folder only.

Name

Type

Required

Description

companyHandle

xsd:string

Yes

The handle to the company with folders with permissions you want to remove.

folderHandle

xsd:string

Yes

Handle to the folder.

updateChildren

xsd:boolean

Yes

When true:

Permissions removal propagates through all folder permission operations.

When false:

The operation affects the specified folder only.

Output (removeFolderPermissionsReturn)

The IPS API does not return a response for this operation.

Examples

This code sample removes permissions from a folder and its subfolders. Set updateChildren to false to remove permissions from the parent folder only.

Request

<removeFolderPermissionsParam xmlns="http://www.scene7.com/IpsApi/xsd">
   <companyHandle>64</companyHandle>
   <folderHandle>blackmesa/Awatermark/</folderHandle>
   <updateChildren>true</updateChildren>
</removeFolderPermissionsParam>

Response

None.