Permissions

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

This article lists possible values for elements in the permissions array in collection or asset representations. Each value specifies a permission that the current user has on the given resource.

Permissions

The following table lists string values for permissions listed in the API (first column), names of these permissions in the access list in the archive settings in Operations Center (second column, if applicable) and describes what each permission means.

Value	Access List	Description
`View`	Browse	User has permission to access the information about and the contents of a collection. The API only exposes collections to which the request user has access, so this permission is always present.
`Preview`	Quick Renditions	Quick renditions are available in asset data. For more information, see quick rendition lists (TODO: Link).
`Download`	Download	Renditions are available in asset data. For more information, see rendition lists (TODO: Link).
`EditText`	Edit Text	User has permission to update metadata on assets.
`CropRotate`	Rotate	User has permission to crop and rotate assets directly in FotoWeb.
`Delete`	Delete	User has permission to delete assets.
`Comping`	Zoom	User has permission to request zoomed previews of assets.
`TrdParty1`	Custom 1	Custom permission. Can be used to define custom behavior for assets in third-party applications using the API and the access list.
`TrdParty2`	Custom 2	Custom permission. Can be used to define custom behavior for assets in third-party applications using the API and the access list.
`TrdParty3`	Custom 3	Custom permission. Can be used to define custom behavior for assets in third-party applications using the API and the access list.
`TrdParty4`	Custom 4	Custom permission. Can be used to define custom behavior for assets in third-party applications using the API and the access list.
`Alert`	Alerts	User has permission to create alerts in a collection.
`CopyTo`	Copy To	User has permission to copy assets to a collection. Please see Ingestion for more information about copy, move and upload destinations.
`MoveTo`	Move To	User has permission to move assets to a collection. Please see Ingestion for more information about copy, move and upload destinations.
`CopyFrom`	Copy From	User has permission to copy assets to other collections.
`MoveFrom`	Move From	User has permissions to move assets to other collections.
`Rename`	Rename	User has permission to rename assets.
`OpenFile`	Open	User has permission to open assets in FotoWeb Desktop.
`EditFile`	Edit	User has permission to edit assets in FotoWeb Desktop.
`CropFile`	Crop	User has permission to crop assets in FotoWeb Desktop.
`UploadFile`	Upload	User has permission to upload new assets to a collection. Please see Ingestion for more information about copy, move and upload destinations.
`FwdtPlace`	Place	User has permission to place assets in documents using FotoWeb Desktop extensions.
`Export`	Export	User has permission to export assets to external systems.
`Comment`	Comment	User has permission to comment on assets, collections or other resources.
`Remove`		User has permission to remove assets from a link collection.
`Reorder`		User has permission to change the order of assets in a link collection.
`SetPosterAsset`		User has permission to change the poster asset of a collection.
`Add`		User has permission to add assets to a link collection.

Remarks

Not all permissions for all collections can be set using the access list. Some permissions depend on the type of collection and other configuration parameters. For example, the Remove, Reorder and Add permissions apply to albums and depend on the permissions that the request user has on an album and on albums in general. For more information, see album permissions and sharing an album.

Custom permissions (TrdParty1, TrdParty2, ...) are a great way to make an application that is using the API to present data in different ways to different users and groups: An administrator can assign a custom permission to a group, and the application can evaluate this permission to determine what to do.

When copying, moving or uploading assets, it is first necessary to find a destination archive or folder for the operation. One option is to let the user or the application choose among available destinations. In order to do this, the application has to be able to enumerate all destinations. This is described in detail in Ingestion.