Show Menu
TOPICS×

removeFolderPermissions

Removes folder permissions.
Syntax

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (removeFolderPermissionsParam)
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 of the 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 sub-folders. Set updateChildren to false if you need 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.