Sets folder permissions.
Syntax
IpsAdmin
IpsCompanyAdmin
ImagePortalAdmin
Input (setFolderPermissionsParam)
Name | Type | Required | Description |
---|---|---|---|
companyHandle | xsd:string |
Yes | Company handle. |
folderHandle | xsd:string |
Yes | Folder handle. |
setChildren | xsd:boolean |
Yes | Sets permissions on children that belong to the folder. |
permissionArray | types:PermissionUpdateArray |
Yes | Permissions array. |
Output (setFolderPermissionsReturn)
The IPS API does not return a response for this operation.
This code sample specifies a company handle, a folder handle, and a permission array with detailed information about the folder. It applies the same permissions for the children of the parent folder.
Request
<setFolderPermissionsParam xmlns="http://www.scene7.com/IpsApi/xsd">
<companyHandle>64</companyHandle>
<folderHandle>blackmesa/Awatermark/</folderHandle>
<setChildren>true</setChildren>
<permissionArray>
<items>
<groupHandle>521</groupHandle>
<permissionType>Read</permissionType>
<isAllowed>true</isAllowed>
<isOverride>true</isOverride>
</items>
</permissionArray>
</setFolderPermissionsParam>
Response
None.