get_download_auth_token Method

Create a download authorization token for one or more files in a bucket.

Syntax

def get_download_auth_token(allowed_bucket_id: str, allowed_prefix: str, validity_duration: int) -> str: ...

Remarks

This method creates and returns a download authorization token for the files in the bucket specified by AllowedBucketId whose names start with AllowedPrefix. The newly-created token will remain valid for the number of seconds specified by ValidityDuration, which must be a value in the range 1 to 604800 (1 week), inclusive.

Download authorization tokens created using this method can be used by anybody to download an applicable file by name; they cannot be used to download a file by Id. Refer to the download_file method for more information.

The currently-authenticated application key must have the shareFiles capability to call this method successfully, otherwise the server will return an error. Refer to the account_capabilities property for more information.