Click or drag to resize
Resources

The Workspaces API is divided into the following categories, each relating to a distinct part of the service:

Files - The following resources are used to manage the Workspaces Send feature for an organization (a service for ad-hoc sending and receiving of document securely).

Resource

Description

Upload & download

Upload files to the Workspaces server where the files can be shared from and download files received from other Workspaces users

Send

Send files by email to recipients

Enumerate

List the files sent via Workspaces

Manage permissions

Set or change access permissions for files sent via Workspaces

Search

Search for files by text or metadata

Track

View audit and tracking information for activities on files sent and received via Workspaces

Organization administration - The following resources are used to manage the workspaces, Workspaces Inbox, and Sent Items in an Organization account.

Resource

Description

Users

Create, update, and remove the organization's users

Roles

Assign roles to users (e.g. workspace Administrator, Contributor)

Aliases

Set email aliases which enable a user to view, in a single session, all files received under different email addresses

Distribution lists

Setup and manage distribution lists of users. Distribution Lists are named sets of users defined globally at the organization level. They can be used as an alias for sending files or be referred to by workspace groups.

Tags

Define metadata tags that can be assigned to files in workspaces

Watermarks

Define the watermark template that can be applied to files downloaded from workspaces

Global Policies

Set global access and usage policies

Workspace management - The following resources can be used to manage a single workspace. For example, a single workspace might be used by a group that is collaborating on a common set of files.

Resource

Description

Groups & Users

Set up groups and users of a workspace

Folders

Set up folders in a workspace

Enumerate

List the files, folders and groups in a workspace

Alerts

Configure alerts for new or changes to files that users should be aware of

Upload, download

Upload or download files to a workspace

Permissions

Set access permissions for files in a workspace