Allow senders to set package expiration when sending. If workspace settings are configured by the admin, senders can only further restrict the workspace setting. Refer to delete_package_content_after_download_duration and to content_retention_duration. POST: Admin permission required. PUT: Admin or Manager permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
Allow workspace manager to configure workspace collaboration settings. POST: Admin permission required. PUT: Admin permission required. RESPONSE Admin scope (org admin).
If collaboration with users outside the workspace is enabled (external_package_sending_allowed=true and/or external_sharing_allowed=true), enable a whitelist of external users who can be recipients of packages and/or shared folders. To configure the whitelist, POST or PUT to /workspace_collaborators. POST: Admin permission required. PUT: Manager with collaboration settings edit permission or Admin permission required. settings editable by managers required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
If external_package_sending_allowed(_by_managers) and/or external_sharing_allowed(_by_managers) is/are set to true, setting this parameter to true allows those who are allowed to send to or share with external users (all users or workspace managers only) to see email addresses of external users in the list of contacts displayed in the (1) recipients field of the package sending form, and/or (2) the recipients field of the folder sharing form. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
Configure a time-based expiration policy for packages in this workspace by setting this parameter to a non-null value. Once the transfer completes, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained, and includes details about sender, recipients, contents, transfer). If null, contents of packages in this workspace are not deleted based on time. To set a download-based expiration policy, refer to delete_package_content_after_download_duration. Valid values: null - 10 years. Units: seconds. POST: Admin permission required. PUT Manager or Admin permission required. RESPONSE User scope. RESPONSE Admin scope (org admin).
When this parameter is set to true, encryption-at-rest is mandatory for all packages sent in this workspace. Senders must set a passphrase for every package they send, then must deliver the passphrase to the recipient according to local site security practice. Only when the recipient applies that passphrase can the package be decrypted. When this parameter is set to true, the parameter of the /packages endpoint that corresponds to EAR is always set to true and cannot be edited. When this parameter is set to false, the field in the /packages endpoint can be set to true or false, giving the sender the choice whether to apply EAR to a given package or not. POST: Admin permission required. PUT: Admin or Manager permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
Configure a download-based expiration policy for packages in this workspace by setting this parameter to a non-null value. Once all package recipients have downloaded the entire package, a timer begins. After the duration configured for this parameter, package contents are deleted (the package record is maintained, and includes details about sender, recipients, contents, transfer). If null, contents of packages in this workspace are not deleted based on whether or not recipients have downloaded the package. To set a time-based expiration policy, refer to content_retention_duration. Valid values: null - 10 years. Units: seconds. POST: Admin permission required. PUT: Manager or Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
A description for the workspace. POST: Admin permission required. PUT: Manager or Admin permission required. RESPONSE Admin scope (org admin).
Configure a time-based expiration policy for draft packages in this workspace by setting this parameter to a non-null value. When a package is saved as a draft, a timer begins. After the duration configured for this parameter, draft package contents are deleted. If null, contents of draft packages in this workspace are not deleted based on time. To set a time-based expiration policy for non-draft packages in this workspace, refer to content_retention_duration. POST: Admin permission required. PUT Manager or Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
If 'inherit_email_templates' is set to false, configure the footer for email notifications for this workspace. The footer you configure is common to all email notifications for this workspace. POST: Admin permission required. PUT: Manager or Admin permission required. RESPONSE Admin scope (org admin).
If 'inherit_email_templates' is set to false, you can enable or disable the ability to configure email templates specifically for users outside this workspace. When this parameter is set to false, external recipients receive the same email notification messages that users in the workspace receive. POST: Admin permission required. PUT: Admin permission required. RESPONSE Admin scope (org admin).
Not used.
If event_reporting_uri is configured, users can submit JSON of all acceptable headers. If event_reporting_uri is not configured, this parameter does not apply. POST: Admin permission required. Maximum characters: 65535.
The URI to collect event and activity reports. If this parameter is not null, you can use the event_reporting_headers parameter to configure acceptable JSON headers. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).
Require external recipients of packages sent from this workspace to authenticate before they can access the package. POST: Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
Allow members of this workspace to send packages to (1) people outside the workspace and (2) to people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
Allow workspace managers of this workspace to send packages to (1) people outside the workspace and (2) to people who do not have a Files account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).
Allow members of this workspace to share folders with (1) people outside the workspace and (2) with people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.
Allow workspace managers of this workspace to share folders with (1) people outside the workspace and (2) with people who do not have an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).
The file ID of the folder containing users' home folders for this workspace. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).
The image data encoded as a string. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope if params[:include]=true. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
The image type of the workspace logo; for example, image/png or image/jpg. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
Inherit the email notification settings configured at the organization. If set to false, you can configure external email notification settings for this workspace; see 'enable_external_notifications'. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).
Whether or not to inherit the email templates configured at the organization. If set to true, the workspace inherits the settings configured at the organization level. If set to false, you can configure email template settings for this workspace; see 'enable_external_email_templates' and other email notification settings. POST Admin permission required. PUT Admin permission required. RESPONSE Admin scope (org admin).
Whether or not the workspace inherits external notifications. PUT Admin permission required.
Allow members of this workspace to invite users outside the workspace to become workspace members. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
Allow workspace managers of this workspace to invite users outside the workspace to become workspace members. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).
The workspace name. Query parameter for GET method. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
The ID of the node on which workspace folders and packages are stored. Query parameter for GET method. POST Admin permission required. PUT Manager permission required.
Whether or not package download counts are recorded. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
Enable members of this workspace to configure personalized URLs to send when inviting people to submit packages (refer to public_links_allowed). You can set this parameter to true only if url_shortening_enabled is also set to true. Once you enable personalized URLs, you enable a default personalized URL construction and you also allow workspace member to configure the URLs they send. The default URL configuration contains the sender's username or the dropbox name; for example: https://aspera.pub/John_Doe;https://aspera.pub/Dropbox1. Note that dropboxes in the workspace inherit the settings you configure for the workspace as follows: When short URLs are enabled at the workspace (url_shortening_enabled=true): Short URLs are enabled for all dropboxes in that workspace. You cannot disable short URLs for a dropbox. When personalized URLs are enabled at the workspace: Personalized URLs are enabled for all dropboxes in that workspace. You can disable personalized URLs for specific dropboxes if desired. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.
Allow workspace members to send invitations to users outside the workspace, inviting them to send a package to (1) the user who issues the invitation, and (2) the dropboxes in which the user who issues the invitation is a member. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required.
Allow workspace managers to send invitations to users outside the workspace, inviting them to send a package to (1) the workspace manager who issues the invitation, and (2) the dropboxes in which the workspace manager is a member. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).
Allow users in the workspace to send a link to users outside the workspace, allowing them to access a file or folder that the inviter has access to in the workspace. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. The inviter must have proper permission to the file or folder being shared. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
Allow workspace managers to send a link to users outside the workspace, allowing them to access a file or folder that the inviter has access to in the workspace. An outside user can be a person who is a member of a different AoC workspace, or a person without an AoC account. The inviter must have proper permission to the file or folder being shared. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).
The file ID of the root folder containing packages for this workspace. POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).
Where packages are stored POST Admin permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).
Whether or not the users of this workspace can upload to their respective home folders. Set this parameter to false to prevent users from uploading to or creating new folders in their home folders. Restricting these functions is one way to control storage usage in the workspace. To exempt certain workspace members from this restriction, set storage_allowed to true for those members in /workspace_memberships. POST Admin permission required. PUT Admin permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
When members of this workspace send a link that allows the recipeint to send a package (refer to public_invites_allowed), the link generated will have the shortened form; for example: (compared to the standard URL; for example: ). When this parameter is set to true, you can also set personalized_urls_enabled to true. POST Admin permission required. PUT Manager permission and collaboration settings editable by managers required or PUT Admin permission required. RESPONSE Admin scope (org admin).
Enable watermarking on the workspace. Admin only.
WorkspacesParams