Avatar
Documentation Team
  • Created:
  • Updated:
Follow

Elvis 4 REST API - updateAuthKey

GET/POST

http://yourserver.com/services/updateAuthKey
    ?key=<authKey>
    &subject=<subject>
    &validUntil=<Expiry date>
    &description=<Description>
    &downloadOriginal=<true|false>
    &downloadPreview=<true|false>
    &requestApproval=<true|false>
    &requestUpload=<true|false>
    &containerId=<Container asset id>
    &importFolderPath=<Path where files are uploaded>
    &notifyEmail=<Email address>
    &sort=<comma-delimited sort fields>
    &viewMode=<thumbnail|list|mason?>
    &thumbnailFields=<comma-delimited fields>
    &listviewFields=<comma-delimited fields>
    &filmstripFields=<comma-delimited fields>
    &thumbnailZoomLevel=<Zoom level>
    &listviewZoomLevel=<Zoom level>
    &filmstripZoomLevel=<Zoom level>

What does it do?

Update an authKey in Elvis.

With this API call it is possible to update certain properties of an authKey. Please note that it is not possible to add or remove assets from an authKey once it has been created.

Parameters

key

The authKey which will be updated.

Required.
subject

AuthKey subject. When specified, parameter is not allowed to be empty, for example by adding 'subject='.

Optional.
validUntil

Expiry date, in one of the date formats supported by Elvis, see the query syntax guide for details. When specified, parameter is not allowed to be empty, for example by adding 'validUntil='.

Optional.
description

AuthKey description that will be shown to receiver of the link.

Optional.
downloadOriginal

Allow downloading original files. Setting this to true will automatically force downloadPreview to true as well.

Optional. Default is false.
downloadPreview

Allow viewing and downloading previews. Setting this to false will only show thumbnails and will also force downloadOriginal to false.

Optional. Default is false.
requestApproval

Request for approval.

Optional. Default is false.
requestUpload

Allow uploading new files, must be true when asset id's is not specified.

Optional. Default is false.
containerId

Container asset id which uploaded files are related to. Required when requestUpload=true.

Optional.
importFolderPath

folderPath where files are uploaded. Required when requestUpload=true.

Optional.
notifyEmail

Email address to send notifications to when upload or approval is finished. Only relevant when requestUpload=true or requestApproval=true.

Optional.
sort

Client setting, specify a comma-delimited list of fields to sort the results on. Follows the same behavior as sort in REST - search call, see also REST - search.

Optional.
viewMode

Client setting.

  • thumbnail show as list of thumbnails.
  • list show as list.
  • mason show as masonry grid.

Optional. Default is thumbnail.
thumbnailFields

Client setting, comma-delimited list of fieldnames for showing metadata in the thumbnail view.

Optional.
listviewFields

Client setting, comma-delimited list of fieldnames for showing metadata in the list view.

Optional.
filmstripFields

Client setting, comma-delimited list of fieldnames for showing metadata in the filmstrip view.

Optional.
thumbnailZoomLevel

Client setting, thumbnail zoom level in the thumbnail view.

Optional.
listviewZoomLevel

Client setting, thumbnail zoom level in the list view.

Optional.
filmstripZoomLevel

Client setting, thumbnail zoom level in the filmstrip view.

Optional.

Return value

If the operation succeeds an empty JSON object with status 200 will be returned. If the operation fails, an error page with a 500 error status will be returned.

Examples

updateAuthKey

http://demo.elvisdam.com/services/updateAuthKey
    ?key=aayy4ZE
    &requestUpload=true
    &importFolderPath=/Users/admin

This call updates an authKey to allow uploading of assets by setting requestUpload to "true" and setting the importFolderPath to "/Users/admin".

Simple update description

updateAuthKey 
http://demo.elvisdam.com/services/updateAuthKey
    ?key=aayy4ZE
    &description=mydescription

This call updates an authKey and sets the description to "mydescription".

Comments

Do you have corrections or additional information about this article? Leave a comment!

Do you have a question about what is described in this article? Please contact support here.


0 comments

Please sign in to leave a comment.

In this article

    Other articles in this section

    See more