RESTAPI:Transfer Policy
Cryptshare uses Policy Settings that can be defined on the server side to allow or deny usage of the system to certain senders and recipients and to control the transfer options pertaining to specific senders and recipients. You can request the policy rules configured for a specific sender/recipients combination by calling the respective endpoint. The method takes a list of recipient email addresses in the request body and returns the Transfer Policy containing the resulting policy rules.
POST https://<your-url>/api/users/<sender-email-address>/transfer-policy
In case the sender's email address is not allowed at all, an exception is returned.
In other cases, a result object is returned with the following information:
| Description | Property |
|---|---|
| Whether a transfer with the requested sender-recipient combination would be allowed or not. | allowed |
| The evaluated policy settings of the matching policy rules. This is only set the transfer would be allowed at all. | settings |
| List of all recipients to which the given sender is not allowed to perform a transfer. This is only set if the transfer would not be allowed. | failedRecipients |
The evaluated policy settings contain the following information:
| Description | Property |
|---|---|
| Max. number of days the transfer is retrievable, starting at the transfer's provision time. | maxRetentionPeriod |
| Max. total size of all files in bytes. | maxTotalSize |
| Default setting for showing file names in notifications and logs. | showFileNamesDefault |
| Specifies whether the showFileNamesDefault setting is changeable or not. | showFileNamesChangeable |
| Default setting for showing file names within ZIP files in notifications and logs. This only has an effect if file names are shown in general. | showZipFileContentDefault |
| Default setting for sending download notifications on file retrieval. | sendDownloadNotificationsDefault |
| Specifies whether the sendDownloadNotificationsDefault setting is changeable or not. | sendDownloadNotificationsChangeable |
| Specifies whether a confidential message can be part of the transfer or not. | confidentialMessageAllowed |
| Specifies whether a confidential message has to be part of the transfer or not. | confidentialMessageRequired |
| Specifies whether the recipient notification can be edited or not. | recipientNotificationEditable |
| List of available security modes (OneTimePasswordSecurityMode, QuickSecurityMode, EidSecurityMode), ordered by priority. The first element is meant to be set as default by the client. | securityModes |