setAssetPermissions

Last update: 2022-03-08
  • Created for:
  • Developer
    Admin

Sets the permissions of a single asset by using a permission asset.

Assets inherit the permissions of their parent folder by default. Once you set permissions on an asset, it no longer inherits the permissions of its parent unless you call removeAssetPermissions.

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (setAssetPermissonsParam)

Name Type Required Description
companyHandle xsd:string Yes The handle to the company that contains the folder you want to work with.
assetHandle xsd:string Yes Folder handle.
permissionArray types:PermissionsUpdateArray Yes Permissions array.

Output (setAssetPermissonsReturn)

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

Examples

This code sample sets permissions on an asset. It contains the company and asset handle, and a permissions array.

Request

<setAssetPermissionsParam xmlns="http://www.scene7.com/IpsApi/xsd">
   <companyHandle>64</companyHandle>
   <assetHandle>97374|1|61046</assetHandle>
   <permissionArray>
      <items>
         <groupHandle>521</groupHandle>
         <permissionType>Read</permissionType>
         <isAllowed>true</isAllowed>
         <isOverride>true</isOverride>
      </items>
   </permissionArray>
</setAssetPermissionsParam>

Response

None.

On this page