# ShareFile MCP connector

The ShareFile connector lets Claude, ChatGPT, Cursor, or the Elaichi Agent find, download, share, and organize the files and folders in your ShareFile account, with each person signed in as themselves and every action logged.

Source: https://elaichi.ai/connectors/sharefile/

## Facts

| | |
| --- | --- |
| Application | ShareFile |
| Category | Cloud Storage |
| AI tools | 315 |
| Authentication | Connects over OAuth |
| Needs your own OAuth app | Yes |
| MCP endpoint | https://api.elaichi.ai/mcp |
| Works with | Claude, ChatGPT, Cursor, any MCP client, and the Elaichi Agent |
| Tools advertised by name | No. 315 tools is past the 30-tool threshold, so clients use `search_tools` and `execute_tool` |

## What you can ask once ShareFile is connected

- List the folders shared with the Finance team.
- Show items added to the client uploads folder this week.
- Download the signed contracts folder and summarize its notes.

## Connect ShareFile in Elaichi

This happens once for the organization, before any client is involved.

1. Open Connections, choose Add connection, and pick ShareFile.
2. Optionally set Share with, then press Connect.
3. Supply your own ShareFile app, then approve. ShareFile needs an OAuth app you register yourself, so bring its client ID and secret. One person does this once for the organization.

Credentials are vaulted and nobody, including the AI, reads them back. The connection becomes a toolbox immediately, so you can curate which ShareFile tools are exposed, rename them, or freeze arguments before anyone points a client at it.

## Connect ShareFile to Claude

Endpoint: https://api.elaichi.ai/mcp

1. Open Customize, then Connectors.
2. Press Add.
3. Name it, paste the MCP server URL, then Continue.
4. Sign in and approve.

On Team and Enterprise, an Owner adds it once. Everyone else turns it on for themselves.

## Connect ShareFile to ChatGPT

Endpoint: https://api.elaichi.ai/mcp

1. Open Plugins, then press the + button.
2. Name it and paste the endpoint into Server URL.
3. Leave Authentication on OAuth, then tick the risk acknowledgement.
4. Press Create, then sign in and approve.

Works on the web today. The plugin directory lives at chatgpt.com/plugins.

## Connect ShareFile to Cursor

Endpoint: https://api.elaichi.ai/mcp

1. Open `~/.cursor/mcp.json`.
2. Add the endpoint under `mcpServers`.
3. Reload Cursor, then sign in and approve.

Set up per machine, so repeat it on each computer you work from.

## Connect ShareFile to any MCP client

Endpoint: https://api.elaichi.ai/mcp

1. Add the endpoint as a remote MCP server.
2. Sign in and approve.

The Elaichi Agent already has these tools, with nothing to set up.

## What the consent screen decides

Only Read is granted by default, which is not enough to call a ShareFile tool. Over MCP there is no trusted place to confirm a write in the moment, so the consent screen is the standing approval rather than a formality. Grant Read and Run tools. Think hard before granting Delete, which reaches into connected apps and cannot be undone.

## What teams do with ShareFile through Elaichi

### Find the latest version of a client file

Client services. Ask for the most recent signed engagement letter in a client's ShareFile folder and get the file back, without clicking through the folder tree yourself.

### Pull every document in a matter folder

Legal. Gather all the files under a matter's ShareFile folder and download them in one go before a hearing or a closing.

### Send a secure link for a completed return

Accounting. Create a ShareFile share link for a finished tax return and paste it into the client email, with the link settings you already use.

### File onboarding paperwork into the right folder

HR. Create a new hire's ShareFile folder, copy the standard forms into it, and leave a note on what is still outstanding.

### Tidy up old and duplicate folders

Operations. Get a view of the whole ShareFile folder tree, spot what has piled up, and clear out the folders that are no longer needed once someone has confirmed.

### Share a proposal folder with a prospect

Sales. Set up a ShareFile folder for a deal, copy the proposal and pricing sheet into it, and generate a link the prospect can open.

## Frequently asked questions

### How do I connect ShareFile to Claude?

Two steps. First, connect ShareFile in Elaichi: ShareFile asks you to register an OAuth application inside your ShareFile account, so an admin brings a client ID and secret once, then signs in to ShareFile with the usual login. Second, open Claude, go to Customize, then Connectors, then Add, and paste https://api.elaichi.ai/mcp as the address. Claude will ask you to sign in to Elaichi, and from then on it can work with your ShareFile files and folders.

### Does ShareFile work with ChatGPT and Cursor as well as Claude?

Yes. Once ShareFile is connected in Elaichi, the same address, https://api.elaichi.ai/mcp, works in Claude, ChatGPT, Cursor, any other MCP client, and the Elaichi Agent. You connect ShareFile once and every client you use picks it up.

### What can an AI agent actually do with my ShareFile data?

It can find files and folders in ShareFile by name or by path, open a file's details, download one file or a whole folder's worth, and show you how a folder is organized. It can also create folders, copy files between them, create and update share links, leave notes on items, check a file back in, and delete items if you allow that. Short, concrete asks work best, such as "find the signed contract in the Acme folder" rather than a long paragraph.

### Does connecting ShareFile give the AI access to every folder in my account?

No. The AI only sees the ShareFile folders and files the signed-in person can already open, because every action runs under that person's own ShareFile access and permissions. Elaichi can narrow that further, for example to read-only, but it can never give the AI more than the person already has in ShareFile.

### Can my team share one ShareFile connection?

Yes. One person connects ShareFile in Elaichi and shares the connection with a team, so nobody else has to register an OAuth application or handle a client secret. Each teammate still signs in as themselves, so the audit log records exactly who downloaded, shared, or moved which ShareFile file.

### Can I stop an agent from deleting or changing things in ShareFile?

Yes. In Elaichi you restrict ShareFile actions one by one, so you can allow finding and downloading files while blocking deleting, copying, or creating share links. A blocked action is never shown to Claude, ChatGPT, or any other client at all, so no prompt can reach it, and the restriction applies across every client at once.

### What happens to a ShareFile connection when someone leaves?

When you offboard a person in Elaichi, their access to ShareFile through Claude, ChatGPT, Cursor, and the Elaichi Agent ends immediately. If they had shared a ShareFile connection with a team, it keeps working for everyone else. If you ever want ShareFile gone entirely, disconnecting it once in Elaichi removes it from every client.

## All 315 ShareFile tools

Every tool below is callable through https://api.elaichi.ai/mcp once ShareFile is connected, subject to the toolbox it is in and the restrictions on the caller.

- **List all ShareFile items** (List). Get the home folder for the current ShareFile user. Returns: Id, Name, FileName, Description, CreationDate, ProgenyEditDate, ExpirationDate, Path, StreamID, State, FileSizeBytes, FileSizeInKB, FileCount, DiskSpaceLimit, BandwidthLimitInMB, ExpirationDays, IsHidden, HasPendingDeletion, IsTemplateOwned, HasPermissionInfo, HasMultipleVersions, AssociatedFolderTemplateID, CreatorFirstName,…
- **Get single ShareFile item by ID** (Get). Get a single ShareFile Item by id. Supports special ids: home, favorites, allshared, connectors, box, top. Returns: Id, Name, FileName, Description, CreationDate, ProgenyEditDate, ExpirationDate, Path, StreamID, State, FileSizeBytes, FileSizeInKB, FileCount, DiskSpaceLimit, BandwidthLimitInMB, ExpirationDays, IsHidden, HasPendingDeletion, IsTemplateOwned, HasPermissionInfo, HasMultipleVersions,…
- **ShareFile items download** (Download). Download a ShareFile item by id. Returns a 302 redirect to the actual download link; for folders, the link retrieves a ZIP archive of the folder contents. Required: id.
- **ShareFile items get by path** (Get). Get a ShareFile item by its file path. Returns the item including id, Name, Description, FileName, ExpirationDate, Parent, Zone, Uri, Link, and ConnectorGroup. Required: path.
- **Delete a ShareFile item by ID** (Delete). Delete a ShareFile item by id. Optional singleversion flag deletes only the specified version instead of all sibling files with the same filename; forceSync blocks asynchronous operation. Returns an empty 204 response on success. Required: id.
- **Create a ShareFile item** (Create). Create a new folder in ShareFile under a specified parent item. Returns the created folder object including its Name, Description, Zone, and ExpirationDate. Required: parent_id.
- **ShareFile items get treeview** (Get). Get a TreeView folder structure for a ShareFile item by id, tailored for folder-tree navigation in copy, move, or manage operations. Returns the tree root Item including Id, Name, Description, Zone, ExpirationDate, and StreamID. Required: id.
- **ShareFile items get stream** (Get). Get all versions of a ShareFile file stream. The id must be a StreamID; an empty list is returned if it is not. Returns Item versions including Id, Name, FileName, StreamID, CreationDate, and ExpirationDate. Required: id (StreamID).
- **ShareFile items get by relative path** (Get). Get a ShareFile item by a path relative to a parent item id. May redirect to another API provider if the path contains a symbolic link. Returns the Item including Id, Name, Description, FileName, ExpirationDate, and StreamID. Required: id, path.
- **ShareFile items get parent** (Get). Get the parent Item of a ShareFile item by id. Returns the parent Item including Id, Name, Description, FileName, ExpirationDate, and StreamID. Required: id.
- **ShareFile items get children** (Get). List the children of a ShareFile item by id. A 302 redirection is returned if the folder is a SymbolicLink. Returns child Items including Id, Name, Description, FileName, StreamID, CreationDate, and ExpirationDate. Required: id.
- **ShareFile items get info** (Get). Get the effective access controls for the current authenticated user on a specific ShareFile folder. Returns: HasVroot, IsSystemRoot, IsAccountRoot, IsVRoot, IsMyFolders, IsAHomeFolder, IsMyHomeFolder, IsAStartFolder, IsSharedFolder, IsPassthrough, CanAddFolder, CanAddNode, CanView, CanDownload, CanUpload, CanSend, CanDeleteCurrentItem, CanDeleteChildItems, CanManagePermissions,…
- **ShareFile items bulk download** (Download). Initiate a bulk download of multiple items in Sharefile from a parent folder. Returns a 302 redirect to the actual download link. The request body is a JSON array of item IDs to download. Required: id (parent folder id) and ids (array of item IDs).
- **ShareFile items create note** (Create). Create a new Note as a child of a parent item in ShareFile. Returns the created Note object including its Id, Name, and Description. Required: parentid, Name.
- **ShareFile items create link** (Create). Create a new Link item in ShareFile under a specified parent item. Returns the created Link object including its Name, Description, and Uri. Required: parentid.
- **ShareFile items create symbolic link** (Create). Create a SymbolicLink in ShareFile under the specified account as a top-level folder. The body needs either a Link URI or FileName plus Zone for path-to-URI conversion. Returns: Id, Name, Description, Link, Zone, ConnectorGroup. Required: accountid.
- **ShareFile items update link** (Update). Update a ShareFile Link by id, optionally sending notifications to folder listeners. Returns: Id, Name, Uri, Description, Parent. Required: id.
- **ShareFile items update note** (Update). Update a Note in ShareFile by id. Returns the modified Note object including its Id, Name, Description, and Parent. Required: id.
- **ShareFile items update symbolic link** (Update). Update a Symbolic Link in ShareFile by id. Returns the modified SymbolicLink object including its Name, Description, Link, Zone, and ConnectorGroup. Required: id.
- **ShareFile items bulk delete** (Delete). Delete multiple items from a parent folder in ShareFile. All items must be children of the same parent identified by parentid. The request body is a JSON array of item IDs. Returns an empty 204 response on success. Required: parentid. If forceSync is false, operations over a certain size are rescheduled asynchronously; set deletePermanently to true to bypass the Recycle Bin.
- **ShareFile items get thumbnail** (Get). Retrieve a thumbnail link for a ShareFile item by id. Returns a Redirection object with the thumbnail Uri when redirect is false, or a 302 redirect to the thumbnail URL when redirect is true. Required: id.
- **ShareFile items get breadcrumbs** (Get). Get the breadcrumb path from the root to a ShareFile item by id. Returns a feed of Item objects representing the folder path in order, each containing Id, Name, FileName, Description, FileCount, StreamID, CreationDate, ExpirationDate, Parent, and Zone. Required: id.
- **ShareFile items copy** (Copy). Copy a ShareFile item to a new target folder by id. Returns the modified source Item object including Id, Name, FileName, Description, FileCount, StreamID, CreationDate, ExpirationDate, Parent, and Zone. If the target folder is in another zone, an AsyncOperation record is returned instead. Required: id, targetid.
- **ShareFile items check in** (Action). Unlock (check in) a locked file in ShareFile. Returns the Item object including Name, Description, Zone, and ExpirationDate. Required: id. Only implemented in Sharepoint providers (/sp).
- **ShareFile items check out** (Action). Check out (lock) a file in ShareFile, preventing other users from editing it. Returns the item object including Name, Description, Zone, and ExpirationDate. Required: id. Only implemented in Sharepoint providers (/sp).
- **ShareFile items discard check out** (Action). Discard the existing checkout lock on a ShareFile item. This operation is only implemented in SharePoint providers. Returns an empty 204 response on success. Required: id.
- **ShareFile items search** (Search). Search ShareFile items matching a query string across folders, files, notes, and links. Returns: Id, Name, Description, Zone, ExpirationDate, Uri, ConnectorGroup, Link. Required: query.
- **ShareFile items search in folder** (Search). Search for items matching a query string within a specific folder in ShareFile. Returns matching items with Name, Description, Zone, ExpirationDate, Uri, and ConnectorGroup. Required: id (folder), query.
- **ShareFile items advanced simple search** (Search). Search for ShareFile items matching specified criteria such as item type, parent ID, creator ID, search query text, and creation date range. Returns matching items with Id, Name, Description, Zone, ExpirationDate, Uri, and ConnectorGroup. Paging.PageNumber and Paging.PageSize are deprecated; use Paging.Count and Paging.Skip.
- **ShareFile items advanced search** (Search). Search for ShareFile items matching advanced criteria including item types, parent folders, creators, creation date range, and free-text query. Returns matching items with their Id, Name, Description, ExpirationDate, and Zone. Required: a request body containing at minimum the Query object. Paging.Count defaults to 50 and Paging.Skip defaults to 0; Paging.PageNumber and Paging.PageSize are…
- **ShareFile items get web view** (Get). Get a web preview link for a ShareFile item, redirecting the caller to the Web Edit application. Returns: Uri. Returns 404 (Not Found) if the Web Preview app doesn't support the file type. Required: id.
- **ShareFile items get protocol links** (Get). Get a list of protocol links for a ShareFile item filtered by platform. Returns: value. Required: id, platform. Platform can be 'all', 'web', 'webandmobile', or 'mobile'. Returns 404 if not supported by the item.
- **ShareFile items get redirection** (Get). Get the redirection endpoint for a ShareFile item by id. Returns: Name, Description, Zone, ExpirationDate, Uri, ConnectorGroup, Link. Required: id. Applies to Folders and SymbolicLinks only; returns an error for other item types.
- **ShareFile items get deleted children** (Get). List recoverable/deleted items inside a specific ShareFile folder. Returns: Id, Name, Description, Zone, ExpirationDate, Uri, Link, ConnectorGroup. Required: parentid.
- **ShareFile items get user deleted items** (Get). List recoverable/deleted items for a specific ShareFile user. Returns: Id, Name, Description, Zone, ExpirationDate, Uri, Link, ConnectorGroup. Required: userid.
- **ShareFile items bulk restore** (Restore). Restore expired ShareFile items to their original locations by providing an array of item IDs. Returns an empty 204 response on success. Required: ids.
- **ShareFile items bulk delete permanently** (Delete). Permanently delete multiple ShareFile items by providing an array of item IDs, removing them from the Recycle Bin or bypassing it entirely. Returns an empty 204 response on success. Required: ids.
- **ShareFile items create web app link** (Create). Create a one-time use login URI for the ShareFile Web App for a specific item. The user is logged in and routed to the parent folder of the item, or to the folder itself if the item is a folder. Returns a Redirection object with the login link in the Uri field. Required: id.
- **ShareFile items remove template association** (Delete). Remove a template association from a ShareFile item identified by its parent id. Returns the updated item including Name, Description, Zone, and ExpirationDate. Required: parentid.
- **ShareFile items check template owned** (Action). Check whether a ShareFile item template is already part of an existing template structure under a given parent item. Returns the item details including Name, Description, Zone, ExpirationDate, Uri, and Link. Required: parentid.
- **ShareFile items check versioning violation** (Action). Check if a versioning change on a ShareFile folder would result in file deletions. Required: parentid, newMaxVersions. Returns an empty 204 response on success.
- **ShareFile items check if previewable** (Action). Check if items would be previewable when created under a specific parent folder in ShareFile. Accepts an array of items with FileName and FileSizeBytes. Required: parentid. Returns an empty 204 response on success.
- **ShareFile items get by dlp status** (Get). Get ShareFile items filtered by Data Loss Prevention scan status. Returns: Id, Name, FileName, Description, CreationDate, ExpirationDate, Zone, Parent. Required: status.
- **ShareFile items upload** (Upload). Prepare upload links for uploading a file to a ShareFile folder. Returns an Upload Specification object including ChunkUri, FinishUri, IsResume, ResumeIndex, ResumeOffset, and ResumeFileHash. Required: id (target folder identifier).
- **ShareFile items upload 2** (Upload). Prepare upload links for a file in a ShareFile folder using POST body parameters (capitalized). Returns an Upload Specification object with ChunkUri, FinishUri, and resume fields (IsResume, ResumeIndex, ResumeOffset, ResumeFileHash). Required: id (target folder ID), and a JSON body with Method, FileName, and FileSize.
- **ShareFile items bulk update** (Update). Update a ShareFile item by id. Returns the modified item including id, Name, Description, FileName, ExpirationDate, Parent, and Zone. For Folders, Name and FileName must be consistent; modifying Zone returns an AsyncOperation. Required: id.
- **List all ShareFile shares** (List). List all outstanding ShareFile shares created by the authenticated user. Returns each share's Id, ShareType, Title, ExpirationDate, RequireLogin, Items, Recipients, Parent, IsViewOnly, and access policy fields. Expired shares are included by default.
- **Get single ShareFile share by ID** (Get). Get a single ShareFile share by id. Returns the full share object including Id, ShareType, Title, ExpirationDate, RequireLogin, Items, Recipients, Parent, IsViewOnly, and access policy fields. Required: id.
- **Create a ShareFile share** (Create). Create a new Send or Request share in ShareFile. Returns the created share including Id, ShareType, Title, ExpirationDate, RequireLogin, Items, Recipients, Parent, IsViewOnly, and access policy fields. Required: ShareType.
- **ShareFile shares get recipient** (Get). Get a single Share Recipient (Share Alias) in ShareFile by alias id within a share. Returns the Share Alias object including its id and access/download tracking information for the recipient. Required: parentid, id.
- **ShareFile shares get item** (Get). Get a single Item within a Send Share in ShareFile. Returns: Id, Name, Description, Zone, ExpirationDate, Uri, Link, ConnectorGroup. Required: shareid, itemid.
- **ShareFile shares download** (Download). Download items from a ShareFile share. By default, redirects the caller (302) to the download address for the share contents — a single-item share downloads the item directly, while a multi-item share produces a ZIP archive named Files.zip. When redirect is set to false, returns a DownloadSpecification object on a 200 response instead. Required: shareid.
- **ShareFile shares upload prepare** (Upload). Prepare upload links for uploading files to a ShareFile share via the Upload2 endpoint, which accepts parameters in the POST body. Returns an Upload Specification containing ChunkUri, FinishUri, and resume parameters (IsResume, ResumeIndex, ResumeOffset, ResumeFileHash). Required: id. The Method field determines the upload protocol (standard, streamed, or threaded).
- **ShareFile shares get recipients** (Get). List recipients of a ShareFile share. Each recipient is identified by a unique alias ID and contains access information such as the user's email, name, and company. Returns: Id, Email, FirstName, LastName, Company. Required: id.
- **ShareFile shares create recipient** (Create). Create a recipient user for a ShareFile share that requires user information. Returns the created recipient alias with Id, Email, FirstName, LastName, Company. Required: parentid, Email.
- **ShareFile shares get items** (Get). List the items (files and folders) contained in a ShareFile send share. Returns: Name, Description, Zone, ExpirationDate, Uri, Link, ConnectorGroup. Required: id.
- **ShareFile shares get item thumbnail** (Get). Retrieve a thumbnail link for a specific Item in a ShareFile Share. When redirect is true, returns a 302 redirection to the thumbnail link; when false, returns 200 OK with a Redirection object containing the thumbnail Uri. Required: shareid, itemid. Only 75px and 600px thumbnail sizes are supported; size defaults to 75px.
- **ShareFile shares get item protocol links** (Get). Get a list of protocol links for a specific item in a ShareFile share, filtered by the requesting platform. Returns a list of protocol links for the item, or 404 (Not Found) if protocol links are not supported by the item. Required: shareid, itemid, platform (one of: all, default, web, webandmobile, mobile).
- **ShareFile shares download with alias** (Download). Download items from a ShareFile share for a specific recipient identified by alias id. By default, redirects the caller (302) to the download address for the share contents; set redirect to false to receive a DownloadSpecification object instead. Required: shareid, aliasid.
- **ShareFile shares bulk download with alias** (Download). Download multiple items from a ShareFile share for a specific recipient identified by their alias ID. Accepts a list of item IDs in the request body. By default redirects (302) to the download link; when redirect is false, returns a DownloadSpecification object. Required: id, aliasid.
- **ShareFile shares create alias** (Create). Create a share alias in ShareFile, associating a recipient email with the specified share. If the user does not exist it is created first; for shares requiring login an activation email is sent. Returns the Share object including Id, ShareType, Title, ExpirationDate, and AliasID. Required: id, email.
- **ShareFile shares delete alias** (Delete). Delete a share alias in ShareFile, removing a recipient's access to the specified share. Returns an empty 204 response on success. Required: id, email.
- **ShareFile shares send** (Send). Send a ShareFile email containing links to specified items to a list of recipient email addresses. Returns the created Share object including Id, ShareType, Title, ExpirationDate, and RequireLogin. Required: Items, Emails, Subject. Default expiration is 30 days; set ExpirationDays to -1 to disable.
- **ShareFile shares send callback** (Send). Receive an analytics callback and send the previously queued ShareFile share email after spam analysis passes. Returns the Share object that was sent, including Id, ShareType, Title, ExpirationDate, and RequireLogin. Required: ShareSendParams.
- **ShareFile shares request** (Action). Send a ShareFile request-for-files email to a list of recipients with a link to upload to a specified folder. Returns the created Share object including Id, ShareType, Title, ExpirationDate, and RequireLogin. Required: Emails, Subject, and FolderId or FolderPath. Default expiration is 30 days; set ExpirationDays to -1 to disable.
- **ShareFile shares resend** (Resend). Resend an existing ShareFile share link email to a list of recipient email addresses or distribution groups. Returns the updated Share object including Id, ShareType, Title, ExpirationDate, and RequireLogin. Required: ShareId, Subject, Recipients.
- **ShareFile shares upload** (Upload). Prepare upload links for uploading files to a target ShareFile Request Share. Returns an Upload Specification including ChunkUri, FinishUri, IsResume, ResumeIndex, ResumeOffset, and ResumeFileHash. Required: id. The method parameter determines the upload protocol (standard, streamed, or threaded).
- **ShareFile shares get redirection** (Get). Get the redirection endpoint information for a specific ShareFile share. Returns the redirection endpoint information for the share. Required: id.
- **ShareFile shares get inbox** (Get). Retrieve all outstanding ShareFile shares in the inbox. Returns a list of share objects including Id, ShareType, Title, Items, Recipients, ExpirationDate, and RequireLogin.
- **ShareFile shares get inbox for user** (Get). Retrieve all outstanding ShareFile shares in a user's inbox. Returns Share objects with Id, ShareType, Title, Items, Recipients, ExpirationDate, RequireLogin, and RequireUserInfo. Required: id.
- **ShareFile shares get message** (Get). Get the sent message content for a specific ShareFile share recipient. Returns the message content as a plain string by default, or as a JSON object with a Message field when asJson is true. Required: share_id, alias_id.
- **ShareFile shares bulk update** (Update). Update an existing ShareFile share by id. Returns the modified share including Id, ShareType, Title, ExpirationDate, RequireLogin, Items, Recipients, Parent, IsViewOnly, and access policy fields. Required: id.
- **ShareFile shares bulk delete** (Delete). Delete an existing ShareFile share by id. Returns an empty 204 response on success. Required: id.
- **List all ShareFile users** (List). List ShareFile users (client and employee users) for the authenticated account. Returns: Id, Email, FirstName, LastName, Company, DefaultZone, Security, StorageQuotaLimitGB, Bandwidth, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Roles. Users without AdminManageEmployees or CanManageUsers permissions receive only minimal user info.
- **Get single ShareFile user by ID** (Get). Get a single ShareFile user by id or email, or the currently authenticated user if no id is supplied. Returns: Id, Email, FirstName, LastName, Company, DefaultZone, Security, StorageQuotaLimitGB, Bandwidth, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Roles. Required: id.
- **Create a ShareFile user** (Create). Create a new client user in ShareFile and associate it to an account. Returns: Id, Email, FirstName, LastName, Company, DefaultZone, Security, StorageQuotaLimitGB, Bandwidth, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Roles. Required: Email.
- **ShareFile users create for folder** (Create). Create a new client user for a specific folder in ShareFile, validating that the caller is an admin of the target folder. Returns the new user object including Id, Email, FirstName, LastName, Company, DefaultZone, IsAdministrator, CanCreateFolders, and Roles. Required: folderId.
- **ShareFile users create employee** (Create). Create a new Employee (AccountUser) in ShareFile and associate it with an account. Returns: Id, Email, FirstName, LastName, Company, StorageQuotaLimitGB, Bandwidth, DefaultZone, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Roles, Security. Required: Email. StorageQuotaLimitGB is optional; if omitted or -1 the account default is applied.
- **ShareFile users update roles** (Update). Add roles to an existing ShareFile user by appending to their current roles. Returns: Id, Email, FirstName, LastName, Company, Roles, DefaultZone, StorageQuotaLimitGB, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Security, Bandwidth. Required: id, Roles.
- **ShareFile users set roles** (Set). Set the roles for a ShareFile user, replacing all existing roles (any roles not provided will be disabled). Returns: Id, Email, FirstName, LastName, Company, Roles, DefaultZone, StorageQuotaLimitGB, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Security, Bandwidth. Required: id, Roles.
- **ShareFile users remove roles** (Delete). Remove specified roles from a ShareFile user by id. Returns the modified user record including Id, Email, FirstName, LastName, Company, and Roles. Required: id. The request body is a JSON array of role names to revoke; removable roles depend on user type.
- **ShareFile users update employee** (Update). Update an existing ShareFile employee (AccountUser) or promote a customer to employee by id. Returns the modified user record including Id, Email, FirstName, LastName, Company, StorageQuotaLimitGB, and Bandwidth. Required: id. StorageQuotaLimitGB of -1 sets account default; Bandwidth of -1 sets unlimited.
- **ShareFile users get home folder** (Get). Get a ShareFile user's home folder by user id. Returns the folder object including Id, Name, Description, and ExpirationDate. Required: id.
- **ShareFile users get top folders** (Get). Get a ShareFile user's top-level folders by user id. Returns a collection of Folder objects including Id, Name, CreationDate, Path, FileCount, and nested Parent and Info metadata. Required: id.
- **ShareFile users get box** (Get). Get a ShareFile user's FileBox children by user id. Returns a collection of Item objects, each with Id, FileName, and FileSizeBytes. Required: id.
- **ShareFile users get preferences** (Get). Get a ShareFile user's preferences record by user id. Returns: EnableFlashUpload, EnableJavaUpload, .... Required: id.
- **ShareFile users update preferences** (Update). Update a ShareFile user's preferences — settings such as upload method and display options. Returns the updated preferences record including EnableFlashUpload and EnableJavaUpload. Required: id.
- **ShareFile users get security** (Get). Get the security record for a ShareFile user by id. Returns the user security object including Email, FirstName, LastName, Company, DefaultZone, Roles, Security, IsAdministrator, and permission flags like CanCreateFolders and CanUseFileBox. Required: id.
- **ShareFile users reset password** (Action). Reset the current user's password in ShareFile. Returns the modified user record including Email, FirstName, LastName, Company, DefaultZone, and Roles. Required: NewPassword, OldPassword.
- **ShareFile users forgot password** (Action). Trigger a reset password email for a ShareFile user by email address. Optional flags indicate whether the request originated from a mobile device or was initiated by an admin. Returns an empty 204 response on success. Required: email.
- **ShareFile users resend welcome** (Resend). Resend the welcome email to a specific ShareFile user. An optional custom message and notify-sender flag can be included. This endpoint is deprecated in favor of Welcome Notification but remains supported. Returns an empty 204 response on success. Required: id.
- **ShareFile users welcome notification** (Action). Send a welcome notification email to a specific ShareFile user with an optional custom message appended to the standard email. Returns an empty 204 response on success. Required: id.
- **ShareFile users delete clients** (Delete). Delete multiple client users in ShareFile by supplying a list of client user ids. Returns an empty 204 response on success. Required: a JSON array of client user ids. The list should not exceed 100 client user ids.
- **ShareFile users bulk delete clients** (Delete). Bulk delete multiple client users in ShareFile by supplying a list of client user ids. Returns an empty 204 response on success. Required: UserIds. The list should not exceed 100 client user ids.
- **ShareFile users downgrade employees** (Action). Downgrade multiple employee users to client users in ShareFile. Returns an empty 204 response on success. Required: UserIds (max 100 employee user ids). Optional: ReassignItemsToId and ReassignGroupsToId to reassign items and groups to another user during downgrade.
- **ShareFile users get all shared folders** (Get). List shared folders a specified ShareFile user has access to. Returns Folder objects including Id, Name, Description, Zone, and ExpirationDate. Required: userid.
- **ShareFile users get top level folders** (Get). Retrieve the top-level folders for the authenticated ShareFile user. Returns a list of Folder objects including id, name, and description. Requires the account to use the new UI model (My Files, Shared, Connectors, Favorites tabs); otherwise returns an empty list (the new UX model has been the default since May 2013).
- **ShareFile users get sharepoint connectors** (Get). List SharePoint connector folders accessible to the authenticated ShareFile user. Returns a list of Folder objects with id, name, description.
- **ShareFile users confirm** (Action). Confirm the current ShareFile user logging in for the first time by submitting confirmation settings including name, company, password, security question, timezone, date/time format, email interval, and notification locale. Returns an empty 204 response on success.
- **ShareFile users get info** (Get). Get information about the currently authenticated ShareFile user. Returns the User object including Email, FirstName, LastName, Company, DefaultZone, Security, IsAdministrator, CanManageUsers, and Roles.
- **ShareFile users delete email address** (Delete). Delete an email address from a ShareFile user. Returns the updated User object including Email, FirstName, LastName, Company, DefaultZone, and Security. Required: email.
- **ShareFile users make primary email** (Action). Set an email address as the primary email for the currently authenticated ShareFile user. Returns the updated user object including Email, FirstName, LastName, Company, DefaultZone, IsAdministrator, and Roles. Required: email.
- **ShareFile users send confirmation email** (Send). Send a confirmation email to a specified email address for verification of the current ShareFile user. Returns the user object including Email, FirstName, LastName, Company, DefaultZone, IsAdministrator, and Roles. Required: email.
- **ShareFile users send email verification code** (Send). Send an email verification code to a user's email address in ShareFile. Returns an empty 204 response on success. Required: email.
- **ShareFile users send marketing verification code** (Send). Send an email verification code for a marketing email address in ShareFile. Returns a ResponseWrapper containing an EmailVerificationCodeMarketingData object. Required: email.
- **ShareFile users verify email address** (Verify). Verify a user's email address by verification code in ShareFile. Returns an empty 204 response on success. Required: email, verificationCode.
- **ShareFile users create web app link** (Create). Create a one-time use login URI for the ShareFile Web App. Returns a Redirection object populated with a link in the Uri field.
- **ShareFile users get inbox metadata** (Get). Get inbox metadata for a specific ShareFile user by user id. Returns: Email, FirstName, LastName, Company, DefaultZone, StorageQuotaLimitGB, Bandwidth, IsAdministrator, CanCreateFolders, CanUseFileBox, CanManageUsers, Security, Roles. Required: userid.
- **ShareFile users get inbox** (Get). Get all outstanding Shares in a ShareFile user's inbox. Returns: Id, ShareType, Title, ExpirationDate, RequireLogin, RequireUserInfo, IsViewOnly, Items, Recipients, Parent, TrackUntilDate, SendFrequency, SendInterval. Required: id.
- **ShareFile users get sent messages** (Get). Get sent messages (a feed of Shares) for a specific ShareFile user. Returns: Id, ShareType, Title, ExpirationDate, RequireLogin, RequireUserInfo, IsViewOnly, Items, Recipients, Parent, TrackUntilDate, SendFrequency, SendInterval. Required: user_id.
- **ShareFile users create web app manage user** (Create). Create a one-time use login URI for the ShareFile Web App for a specific user. Returns: Uri. Required: user_id.
- **ShareFile users create web app manage users** (Create). Create a one-time use login URI for the ShareFile Web App for managing users. Returns: Uri.
- **ShareFile users create web app add employee** (Create). Create a one-time use login URI for the ShareFile Web App for adding a new employee. Returns: Uri.
- **ShareFile users bulk update** (Update). Update an existing ShareFile user by id. Modifies FirstName, LastName, Company, Email, Security.IsDisabled, DefaultZone Id, StorageQuotaLimitGB, and Bandwidth. Returns: Id. Required: id.
- **ShareFile users bulk delete** (Delete). Delete a ShareFile user by id. When completely is false, the user is disabled rather than permanently removed; when true, all records are permanently deleted. Use itemsReassignTo and groupsReassignTo to reassign the user's items and groups. Required: id.
- **List all ShareFile groups** (List). List all distribution groups in a ShareFile account that the authenticated user has permission to view. Returns: Id, Name, IsShared, Contacts, odata.metadata.metadata.
- **Get single ShareFile group by ID** (Get). Get a single ShareFile group by id. Returns: Id, Name, IsShared, Contacts, odata.metadata.metadata. Required: id.
- **Create a ShareFile group** (Create). Create a new distribution group in ShareFile. The post body must include the group specification with contacts. Returns: Id, Name, IsShared, Contacts, odata.metadata.metadata. Required: Name.
- **ShareFile groups add contacts** (Add). Add contacts to a ShareFile group by providing a list of contact objects identified by Id or Email. Returns the updated list of group contacts including Id and Email. Required: id.
- **ShareFile groups remove contacts** (Delete). Remove contacts from a ShareFile group by providing a list of contact objects identified by Id or Email. Missing references are silently ignored; Id is looked up before Email. Returns the updated list of group contacts including Id and Email. Required: id.
- **ShareFile groups get contacts** (Get). List the contacts (members) of a ShareFile group. Returns: Id, Email. Required: id.
- **ShareFile groups export document** (Export). Export the contacts of a ShareFile group as a spreadsheet or CSV file. Returns a file download with content-type-specific content. Required: id.
- **ShareFile groups get for user** (Get). List all groups associated with a ShareFile user. Returns each group's Id, Name, IsShared, and Contacts. Required: id. This is currently limited to the authenticated user.
- **ShareFile groups bulk update** (Update). Update an existing ShareFile group by id. This operation ignores the provided contacts list; use the Contacts navigation link to add or remove members. Returns: Id, Name, IsShared, Contacts, odata.metadata.metadata. Required: id.
- **ShareFile groups bulk delete** (Delete). Delete a ShareFile group by id. Returns an empty 204 response on success. Required: id.
- **List all ShareFile reports** (List). List all ShareFile reports configured for the current account. Returns: Id, Title, ReportType, ActivityTypes, ObjectType, ObjectId, DateOption, SaveFormat, IsRecurring, IsScheduled, Frequency, Records. The Records property is expandable to access individual ReportRecords.
- **Get single ShareFile report by ID** (Get). Get a single ShareFile report by id. Returns: Id, Title, ReportType, ActivityTypes, ObjectType, ObjectId, DateOption, SaveFormat, IsRecurring, IsScheduled, Frequency, Records. The Records property is expandable. Required: id.
- **Create a ShareFile report** (Create). Create a new ShareFile report with specified configuration such as title, report type, activity types, and date options. Returns: Id, Title, ReportType, ActivityTypes, ObjectType, ObjectId, DateOption, SaveFormat, IsRecurring, IsScheduled, Frequency, Records. Optional query parameter runOnCreate controls whether the report runs immediately on creation.
- **ShareFile reports run** (Run). Run a ShareFile report by id and get the run id. Returns: Id. Required: id.
- **ShareFile reports get recent** (Get). Get the most recent reports run for the current ShareFile account. Returns: Id, Title, ReportType, ActivityTypes, ObjectType, ObjectId, DateOption, SaveFormat, IsRecurring, IsScheduled, Frequency, Records. 10 reports are returned unless maxReports is specified.
- **ShareFile reports get recurring** (Get). List all recurring reports for the current ShareFile account. Returns: Id, Title, ReportType, ActivityTypes, ObjectType, ObjectId, DateOption, SaveFormat, IsRecurring, IsScheduled, Frequency.
- **ShareFile reports get record** (Get). Get a single report record by id in ShareFile. Returns: Id, Title, ReportType, ActivityTypes, ObjectType, ObjectId, DateOption, SaveFormat, IsRecurring, IsScheduled, Frequency. Required: id.
- **ShareFile reports get records** (Get). List all records for a specific ShareFile report by report id. Returns: Id, Title, ReportType, ActivityTypes, ObjectType, ObjectId, DateOption, SaveFormat, IsRecurring, IsScheduled, Frequency. Required: id.
- **ShareFile reports preview** (Action). Get a preview location for a ShareFile report. Returns: Title, ReportType, SaveFormat, Frequency, IsRecurring, IsScheduled. Required: report_id.
- **ShareFile reports get JSON data** (Get). Get JSON-formatted results data for a ShareFile report record by id. Returns: Title, ReportType, ActivityTypes, ObjectType, ObjectId, DateOption, SaveFormat, IsRecurring, IsScheduled, Frequency. Required: id.
- **ShareFile reports move** (Move). Move a ShareFile report to a target folder location. Required: report_id, folder_id. Returns an empty 204 response on success.
- **ShareFile reports download data** (Download). Download spreadsheet data for a ShareFile report record. When getSignedUrl is true, returns a Download Specification object with a url pointing to the file location; otherwise returns the Excel-formatted report results directly. Required: id.
- **ShareFile reports bulk update** (Update). Update an existing ShareFile report with partial Report model fields. Returns the updated report including Title, ReportType, IsRecurring, IsScheduled, and Frequency.
- **ShareFile reports bulk delete** (Delete). Delete a ShareFile report by id. Returns an empty 204 response on success. Required: id.
- **List all ShareFile workflows** (List). List ShareFile workflows. Returns a feed of Workflow objects including Id, Participants, LastUpdatedDate, and Due. Supports OData $filter and $orderby query parameters.
- **Get single ShareFile workflow by ID** (Get). Get a single ShareFile workflow by id. Returns the Workflow object including Id, Participants, LastUpdatedDate, and Due. Required: id.
- **Create a ShareFile workflow** (Create). Create a new ShareFile workflow with the specified participants. Returns the created Workflow object including Id, Participants, LastUpdatedDate, and Due. Required: Participants.
- **ShareFile workflows get initiated** (Get). List ShareFile workflows initiated by the current user. Returns: Id, LastUpdatedDate, Due, Participants. Skip must be a multiple of 25; Top must be 25 (preferred not to supply); Sort only supported for LastUpdatedDate and Due.
- **ShareFile workflows get shared** (Get). List ShareFile workflows shared with the current user. Returns: Id, LastUpdatedDate, Due, Participants. Skip must be a multiple of 25; Top must be 25 (preferred not to supply); Sort only supported for LastUpdatedDate and Due.
- **ShareFile workflows get link** (Get). Get a protocol link to view a ShareFile workflow in a web browser. Returns: Name, Description, Uri. Required: id.
- **ShareFile workflows create approval** (Create). Create an approval workflow on a ShareFile item. Returns the new workflow including Id, LastUpdatedDate, Due, Participants. Required: id, Participants.
- **ShareFile workflows create feedback** (Create). Create a feedback workflow on a ShareFile item. Returns the new workflow including Id, LastUpdatedDate, Due, Participants. Required: id, Participants.
- **ShareFile workflows bulk update** (Update). Update a ShareFile workflow by id. Returns the updated workflow object including its id and Participants with Contact email and Role. Required: id.
- **ShareFile workflows bulk delete** (Delete). Delete a ShareFile workflow by id. Returns an empty 204 response on success. Required: id.
- **List all ShareFile webhook subscriptions** (List). List all webhook subscriptions for the current ShareFile user. Returns: Id, SubscriptionContext, WebhookUrl, Events.
- **Get single ShareFile webhook subscription by ID** (Get). Get a single webhook subscription in ShareFile by id. Returns: Id, SubscriptionContext, WebhookUrl, Events. Required: id.
- **Create a ShareFile webhook subscription** (Create). Create a webhook subscription in ShareFile to receive event callbacks at a specified URL. Returns: Id, SubscriptionContext, WebhookUrl, Events. Required: SubscriptionContext, WebhookUrl, Events. Context ResourceId is required for all but the account context; MasterAdmin role required for account context subscriptions.
- **ShareFile webhook subscriptions bulk delete** (Delete). Delete a webhook subscription in ShareFile by id. Returns an empty 204 response on success. Required: id.
- **List all ShareFile webhook clients** (List). List ShareFile webhook clients — the webhook configuration settings specific to each OAuth client. Returns each WebhookClient record including its id. No required parameters.
- **Get single ShareFile webhook client by ID** (Get). Get the configuration settings for a webhook client in ShareFile. Returns the WebhookClient object including its Id, SubscriptionContext, WebhookUrl, and Events. Required: id.
- **Create a ShareFile webhook client** (Create). Create a new webhook client in ShareFile to configure webhook settings for a given OAuth client. Returns the created WebhookClient object including its Id and webhook configuration settings. No required parameters.
- **ShareFile webhook clients generate primary key** (Generate). Generate a new primary signature key for a ShareFile webhook client, used to verify webhook payloads via HMAC SHA256. Returns the updated WebhookClient object including its Id. Required: id.
- **ShareFile webhook clients generate secondary key** (Generate). Generate a new secondary signature key for a ShareFile webhook client for key rotation without webhook delivery downtime. Returns the updated WebhookClient object with its Id and remaining webhook configuration attributes. Required: id.
- **ShareFile webhook clients bulk update** (Update). Update the configuration of a ShareFile webhook client by id. Returns the updated webhook client including its Id, SubscriptionContext, WebhookUrl, and Events. Required: id.
- **ShareFile webhook clients bulk delete** (Delete). Delete a ShareFile webhook client configuration by id. Returns an empty 204 response on success. Required: id.
- **ShareFile sessions logout** (Action). Logout the current ShareFile session by invalidating the current Session ID. Returns an empty 204 response on success.
- **ShareFile sessions login** (Action). Login to ShareFile by initiating the authentication flow. Returns the Session object including its id and authentication context attributes. If SAML is configured, redirects to the IDP; otherwise challenges for local credentials.
- **ShareFile sessions acs** (Action). Get the ShareFile Assertion Consumer Service, the IDP callback endpoint in SAML authentication. Returns the Session object including its id and authentication context attributes if authentication is accepted.
- **List all ShareFile accounts** (List). Get the current ShareFile account information for the authenticated subdomain. Returns: Id, Name, odata.metadata, AccessControlType, Domains.metadata.
- **ShareFile accounts get by ID** (Get). Get a single ShareFile account by id. Returns the subdomain account information including id and subdomain. Required: id.
- **ShareFile accounts get branding** (Get). Get branding information for the current ShareFile subdomain account. Returns: attributes, UsernameShort, Password, EmployeeOnly. This operation does not require authentication.
- **ShareFile accounts get employees** (Get). List employees (named users) in the current ShareFile account. Returns: Id, Email, FirstName, LastName, Company. Optional: withRightSignature to filter employees with the CanSendDocumentsForSignature role.
- **ShareFile accounts get clients** (Get). List all client users in a ShareFile account. Clients are restricted users who can send and receive files with employees but have no other permissions besides basic sharing. Returns: Id, Email, FirstName, LastName, Company.
- **ShareFile accounts get address book** (Get). Get the address book for a ShareFile account, optionally filtered by type (personal, shared, or group) and a search term matching email or name. Returns: Id, Name, Email.
- **ShareFile accounts get mobile security** (Get). Get the mobile device security configuration settings for the current ShareFile account. Returns: UsernameShort, Password, EmployeeOnly, AccessControlType, Domains. No required parameters.
- **ShareFile accounts get product defaults** (Get). Get the default product configuration settings for the current ShareFile account. Returns: LogoutUrl, LoginUrl, IPRestrictions, ForceSSO, EntityID, SFEntityID, SPInitatedAuthContext, SPInitatedAuthMethod, AccessControlType, Domains, UsernameShort, Password, EmployeeOnly, EnableDLP, PasswordPolicy.
- **ShareFile accounts get preferences** (Get). Get the current ShareFile account preferences. Returns: EnableDLP, PasswordPolicy, UsernameShort, Password, EmployeeOnly.
- **ShareFile accounts update preferences** (Update). Update ShareFile account preferences including DLP enablement and password policy settings. Returns: EnableDLP, PasswordPolicy, UsernameShort, Password, EmployeeOnly.
- **ShareFile accounts get SSO** (Get). Get the Single Sign-On (SSO) configuration for the current ShareFile account. Returns: AccessControlType, Domains.
- **ShareFile accounts update SSO** (Update). Update the Single Sign-On (SSO) configuration for the current ShareFile account. Returns: LogoutUrl, LoginUrl, IPRestrictions, ForceSSO, EntityID, SFEntityID, SPInitatedAuthContext, SPInitatedAuthMethod, AccessControlType, Domains.
- **ShareFile accounts send to email** (Send). Send the list of ShareFile accounts associated with a user to a specified email address. Required: email. Returns an empty 204 response on success.
- **ShareFile accounts get login access control domains** (Get). Get the login access control list of domains for the ShareFile account, showing which domains are allowed or disallowed to log in. Returns: AccessControlType, Domains.
- **ShareFile accounts get folder access control domains** (Get). Get the folder access control list of domains for the ShareFile account, showing which domains are allowed or disallowed to have access to folders. Returns: AccessControlType, Domains.
- **ShareFile accounts create login access control domains** (Create). Create or replace the login access control list of domains for the ShareFile account. Returns: AccessControlType, Domains. Required: AccessControlType, Domains.
- **ShareFile accounts create folder access control domains** (Create). Create or replace the folder access control list of domains for the ShareFile account. Returns: AccessControlType, Domains. Required: AccessControlType, Domains.
- **ShareFile accounts update login access control domains** (Update). Update the login access control list of domains by merging specified domains with existing ones and/or updating the AccessControlType. Returns: AccessControlType, Domains. At least one of AccessControlType or Domains must be specified.
- **ShareFile accounts update folder access control domains** (Update). Update the Folder Access Control List of domains for a ShareFile account by merging specified domains with existing ones and/or changing the AccessControlType. Returns: AccessControlType, Domains, UsernameShort, Password, EmployeeOnly. At least one of AccessControlType or Domains must be specified in the request body.
- **ShareFile accounts delete login access control domains** (Delete). Delete specified domains from the Login Access Control List for a ShareFile account. Returns an empty 204 response on success. Required: Domains.
- **ShareFile accounts delete folder access control domains** (Delete). Delete domains from the Folder Access Control List in ShareFile. Returns an empty 204 response on success. Required: AccessControlType, Domains.
- **ShareFile accounts require web pop** (Action). Check whether a web popup (WebPop) is required for a ShareFile account during authentication. Returns a RequireWebPopResult object. Required: subdomain, username.
- **ShareFile accounts require subdomain** (Action). Check whether a subdomain is required for a ShareFile user by username or email. Returns a RequireSubdomainResult indicating whether a subdomain is required for login. Required: username.
- **ShareFile accounts find subdomain** (Action). Find the ShareFile user account subdomain based on a short username. Returns: UsernameShort, Password, EmployeeOnly. Required: UsernameShort, Password.
- **ShareFile accounts get outlook info** (Get). Get Outlook integration information for the current ShareFile account. Returns: AccessControlType, Domains. No required parameters.
- **ShareFile accounts get SSO info** (Get). Get Single Sign-On information for a ShareFile account by subdomain. Returns: UsernameShort, Password, EmployeeOnly. Required: subdomain.
- **ShareFile accounts get tenants** (Get). List the tenant accounts managed by a partner account in ShareFile. Returns: id, subdomain, and disk space information for each tenant account.
- **ShareFile accounts get tenant** (Get). Get a specific ShareFile tenant account by id. Returns the tenant account object. Required: id.
- **ShareFile accounts get tenant zone usage** (Get). Get multitenant zone usage information for all tenants of a ShareFile account. Returns zone usage objects for each tenant, including Id, Name, HeartbeatTolerance, and ZoneServices.
- **ShareFile accounts get tenant zones** (Get). List the multi-tenant zones assigned to a ShareFile tenant account. Returns: Id, Name, HeartbeatTolerance, ZoneServices. Required: parent_id.
- **ShareFile accounts create web app admin** (Create). Create a one-time use login URI for the ShareFile Web App. Returns a Redirection object populated with the one-time login link in the Uri field. No request parameters are required.
- **ShareFile accounts bulk update** (Update). Update the branding configuration for a ShareFile account subdomain. Returns the updated branding information for the account, including account-specific branding attributes. No required parameters.
- **ShareFile metadata list by item** (List). List metadata entries for a specific ShareFile item. Returns: Name, Value, IsPublic. Required: id.
- **Create a ShareFile metadatum** (Create). Create a single metadata entry for a ShareFile item. Returns the created metadata object including Name and Value. Required: id, Name, Value. Fails if an entry with the given name already exists for this item.
- **ShareFile metadata update by name** (Update). Update a single metadata entry for a ShareFile item by metadata id. Returns the updated metadata object including Name and Value. Required: id, metadata_id, Value. Fails if an entry with the given name doesn't exist for this item.
- **Update a ShareFile metadatum by ID** (Update). Update a single ShareFile metadata entry identified by metadata name and item id. Returns: Name, Value. Required: name, itemid, Value.
- **ShareFile metadata bulk update** (Update). Bulk update metadata key-value pairs for a ShareFile item, creating new entries for keys not already associated with the item. Returns a list of updated Metadata objects including Name and Value. Required: id, Value.
- **ShareFile metadata delete by name** (Delete). Delete a single ShareFile Metadata entry from an Item by metadata name and item id. Fails if an entry with the given name does not exist for the Item. Returns an empty 204 response on success. Required: name, itemid.
- **ShareFile metadata bulk delete** (Delete). Delete a single ShareFile Metadata entry from an Item by item id and metadata id. Fails if an entry with the given metadata name does not exist for the Item. Returns an empty 204 response on success. Required: id, metadata_id.
- **List all ShareFile access controls** (List). List all access controls in ShareFile. Returns the access control object including Principal, CanUpload, CanDownload, CanView, CanDelete, CanManagePermissions, CanCreate, CanManage, Message, and Item.
- **ShareFile access controls list by item** (List). List access controls for a specific ShareFile item by id. Returns the access control object including Principal, CanUpload, CanDownload, CanView, CanDelete, CanManagePermissions, CanCreate, CanManage, Message, and Item. Required: id.
- **Create a ShareFile access control** (Create). Create a new ShareFile access control entry for an item, assigning rights to a single Principal (User or Group). Returns: AccessControlType, Domains. Required: id, Principal. If CanDownload is true, CanView is automatically enabled; if CanDownload is false, CanDelete is set to false; may return an AsyncOperation when fulfilled asynchronously.
- **Delete a ShareFile access control by ID** (Delete). Delete a ShareFile AccessControl entry by principal ID and item ID. Returns an empty 204 response on success. Required: principalid, itemid.
- **ShareFile access controls bulk set** (Set). Create or update multiple AccessControls for a single Item in ShareFile. Principals can be identified by Id or Email; non-existent users are auto-created. Returns the AccessControlBulkResult object. Required: id, AccessControlParams.
- **ShareFile access controls bulk set for principal** (Set). Create or update multiple access controls for a single principal across multiple items in ShareFile. Each entry specifies an Item and rights for the principal. Returns the AccessControlBulkResult object. Required: principalId, AccessControlParams.
- **ShareFile access controls clone** (Action). Recursively clone access controls from a source principal to multiple target principals for a given folder in ShareFile. Returns the cloned access controls. Required: FolderId, PrincipalId, ClonePrincipalIds.
- **ShareFile access controls bulk delete** (Delete). Delete multiple access controls for a given parent folder in ShareFile. The request body is an array of principal IDs whose access controls should be removed. Returns an empty 204 response on success. Required: grandparentid.
- **ShareFile access controls bulk delete for principal** (Delete). Delete multiple access controls for a given principal in ShareFile. The request body is an array of folder IDs to remove the principal's access from. Returns an empty 204 response on success. Required: principalId.
- **ShareFile access controls notify users** (Action). Notify users that they have access to a parent folder in ShareFile by sending a notification with an optional custom message. Returns an empty 204 response on success. Required: id, UserIds. All users specified must already have access to the parent folder.
- **ShareFile access controls notify users preview** (Action). Preview the notification email that would be sent to users with access to a ShareFile folder before actually sending it. Returns a preview of the folder notification email. Required: id.
- **ShareFile access controls bulk update** (Update). Update an existing ShareFile AccessControl entry for a given Item. The Principal element in the body identifies which AccessControl to modify (provide an Id, Email, or URL); the Principal itself cannot be changed. Returns the modified AccessControl instance including Principal, CanUpload, CanDownload, CanView, CanDelete, CanManagePermissions, and NotifyOnUpload, or an AsyncOperation if the…
- **List all ShareFile apps** (List). List ShareFile apps authorized for the current user. Returns a feed of ConnectedApp objects, each with id. No required parameters.
- **ShareFile apps list for user** (List). List ShareFile apps authorized for a specific user. Returns a feed of ConnectedApp objects, each with id. Required: id.
- **Get single ShareFile app by ID** (Get). Get a single ShareFile app by id. Returns the ConnectedApp object with id. Required: id.
- **ShareFile apps get for user** (Get). Get a single ShareFile app for a specific user. Returns the ConnectedApp object with id. Required: id, appid.
- **ShareFile apps delete for user** (Delete). Revoke a connected app's access for a given ShareFile user. Returns an empty 204 response on success. Required: id, appid.
- **ShareFile apps list tfa** (List). List all Two Factor Authentication apps for the current ShareFile user. Returns a feed of TwoFactorAuthApp objects including their Id.
- **ShareFile apps list tfa for user** (List). List all Two Factor Authentication apps for a given ShareFile user. Returns a feed of TwoFactorAuthApp objects including their Id. Required: id.
- **ShareFile apps get tfa** (Get). Get a single Two Factor Authentication app for the current ShareFile user by id. Returns: id, attributes. Required: id.
- **ShareFile apps get tfa for user** (Get). Get a specific Two Factor Authentication app for a given user in ShareFile. Returns the TwoFactorAuthApp object representing the TFA app configuration. Required: id (user ID), appid.
- **ShareFile apps delete tfa** (Delete). Revoke a two-factor authentication app for the current ShareFile user by app ID. Returns an empty 204 response on success. Required: id.
- **ShareFile apps delete tfa for user** (Delete). Revoke a two-factor authentication app for a specific ShareFile user. Returns an empty 204 response on success. Required: id, tfa_app_id.
- **ShareFile apps bulk delete** (Delete). Revoke a ShareFile app's access for the current user by id. Returns an empty 204 response on success. Required: id.
- **List all ShareFile async operations** (List). Get a single ShareFile async operation by id. Returns: id, State. Required: id.
- **ShareFile async operations get by batch** (Get). List all ShareFile async operations belonging to a specified operation batch. Returns: id, State. Required: id.
- **ShareFile async operations get batch progress** (Get). Get the progress of ShareFile async operations by Operation Batch ID. Returns an AsyncOperation object containing batch progress, including its id and State. Required: id (Operation Batch identifier).
- **ShareFile async operations get by folder** (Get). List ShareFile AsyncOperations associated with a specific folder by source Item ID. Returns: odata.metadata, odata.count, value.count, odata.metadata. Required: id.
- **ShareFile async operations cancel** (Cancel). Cancel a single ShareFile async operation by id. Returns the modified async operation record including its id and State. Required: id.
- **ShareFile async operations cancel batch** (Cancel). Cancel an Async Operation batch in ShareFile, moving all unfinished Async Operation records in the batch to Cancelled state. Returns: id, State. Required: id.
- **ShareFile async operations bulk delete** (Delete). Delete an AsyncOperation in ShareFile by id, cancelling the async operation record (equivalent to the Cancel endpoint). Returns an empty 204 response on success. Required: id.
- **ShareFile async operations bulk update** (Update). Update the State of a ShareFile AsyncOperation by id. Only the State field is updated; other fields in the request body are ignored. Returns the modified AsyncOperation record including its Id and State. Required: id.
- **List all ShareFile capabilities** (List). List ShareFile capabilities for the current provider, indicating which features are available so clients can suppress unsupported UX controls. Returns the capability object with provider-specific fields. Clients must not assume any particular capability is implemented by a given provider.
- **List all ShareFile connector groups** (List). List all ShareFile Connector Groups in the account. Connector Groups represent classes of external data-source Connectors such as Network Shares, SharePoint sites, or other cloud services. Returns: Id, Name, Provider, Zones.
- **Get single ShareFile connector group by ID** (Get). Get a single ShareFile Connector Group by its Service identifier. Returns: Id, Name, Provider, Zones. Required: id.
- **ShareFile connector groups get by provider** (Get). Get a single ShareFile Connector Group by its provider name. Returns: Id, Name, Provider, Zones. Required: provider.
- **ShareFile connector groups get zone** (Get). Get a specific Zone association for a ShareFile Connector Group by Service identifier and Zone identifier. Returns: Zone, StorageCenter, ApiVersionMin, ApiVersionMax, IconUrl, FormUrl. Required: serviceid, zoneid.
- **ShareFile connector groups get access control** (Get). Get a ShareFile Connector Group Access Control entry for a specific user by Service identifier and User identifier. Returns: Principal, CanCreate, CanManage. Required: serviceid, userid.
- **ShareFile connector groups get by zone** (Get). Get ShareFile connector groups defined in a specific zone. Returns: Id, Name, Provider, Zones. Required: zoneid.
- **Create a ShareFile connector group** (Create). Create a new ShareFile connector group associated with a zone, or add a zone to an existing connector group if the service ID already matches. The caller does not need to check if the group exists first. Returns: Id, Name, Provider, Zones. Required: Id, Name, Provider, Zones.
- **ShareFile connector groups add zone** (Add). Associate a zone with an existing ShareFile connector group by id. Returns: Zone, StorageCenter, ApiVersionMin, ApiVersionMax, IconUrl, FormUrl. Required: id, Zone, ApiVersionMin, ApiVersionMax, IconUrl, FormUrl.
- **ShareFile connector groups add access control** (Add). Add a new principal to the access control list of a ShareFile connector group by id. Returns: Principal, CanCreate, CanManage. Required: id, Principal, CanCreate, CanManage.
- **ShareFile connector groups delete zone** (Delete). Delete a ShareFile Connector Group's association with a specific Zone. Connector Groups are automatically removed once removed from all Zones. Returns an empty 204 response on success. Required: parentid, id.
- **ShareFile connector groups delete access control** (Delete). Delete an Access Control entry from a ShareFile Connector Group's ACL, removing the affected principal's permissions to use the Connector Group. Returns an empty 204 response on success. Required: parentid, userid.
- **ShareFile connector groups get storage centers** (Get). List Storage Centers associated with a ShareFile Connector Group zone. Returns: Id, ExternalAddress, HostName, Version. Required: id, zoneid.
- **ShareFile connector groups add storage center** (Add). Associate a Storage Center with a Connector Group's Zone in ShareFile. The Connector Group must already be associated with the Storage Center Zone. Returns the modified Connector Group including Id, Name, Provider, and Zones. Required: id, zoneid, and a Storage Center Id in the request body.
- **ShareFile connector groups bulk update** (Update). Update the parameters of a ShareFile connector group's association with a zone by id and zoneid. Returns: Zone, ApiVersionMin, ApiVersionMax, IconUrl, FormUrl. Required: id, zoneid, Zone, ApiVersionMin, ApiVersionMax, IconUrl, FormUrl.
- **ShareFile connector groups bulk delete** (Delete). Delete a ShareFile Connector Group by id, removing the group and all its Zone associations. Returns an empty 204 response on success. Required: id.
- **List all ShareFile devices** (List). List ShareFile device users for the current user. Returns a feed of DeviceUser objects including id, created_at, updated_at.
- **Get single ShareFile device by ID** (Get). Get a single ShareFile device by id. Returns the device object including id, created_at, updated_at. Required: id.
- **ShareFile devices list for user** (List). List devices for a given ShareFile user. Returns a list of device objects including id, created_at, updated_at. Required: id.
- **ShareFile devices wipe** (Action). Wipe a ShareFile device remotely, removing all ShareFile data from it. Returns an empty 204 response on success. Required: device_id.
- **ShareFile devices lock** (Action). Lock a ShareFile device by device ID. An optional userid query parameter can target a specific user (defaults to the device owner). Returns an empty 204 response on success. Required: device_id.
- **ShareFile devices unlock** (Action). Unlock a ShareFile device by device ID. An optional userid query parameter can target a specific user (defaults to the device owner). Returns an empty 204 response on success. Required: device_id.
- **ShareFile devices bulk delete** (Delete). Delete a specific device for a given ShareFile user. Returns an empty 204 response on success. Required: parentid, id.
- **ShareFile encrypted emails authorize** (Action). Validate authorization for a ShareFile encrypted email by id. Returns a limited authorization token when RequireUserInfo is true and recipient info is provided, or an empty 204 response when the provided authorization is already valid. Required: id.
- **List all ShareFile encrypted emails** (List). Get a ShareFile encrypted email by id. Returns: id, ToRecipients, CcRecipients, BccRecipients, Subject, NotifyOnUse, ExpirationDays, RequireUserInfo, RequireLogin. Required: id.
- **ShareFile encrypted emails get thread** (Get). Get the message thread for a ShareFile encrypted email by id, returning only messages the current user can access. Returns: id, ToRecipients, CcRecipients, BccRecipients, Subject, NotifyOnUse, ExpirationDays, RequireUserInfo, RequireLogin. Required: id.
- **ShareFile encrypted emails get by share** (Get). Get the EncryptedEmail associated with a ShareFile share by share id. Returns: Id, ToRecipients, CcRecipients, BccRecipients, Subject, NotifyOnUse, ExpirationDays, RequireUserInfo, RequireLogin, Message, Attachments. Required: id.
- **Create a ShareFile encrypted email** (Create). Create a new empty ShareFile EncryptedEmail without a body or attachments; this does not send the email. Returns: Id, ToRecipients, CcRecipients, BccRecipients, Subject, NotifyOnUse, ExpirationDays, RequireUserInfo, RequireLogin, Message, Attachments.
- **ShareFile encrypted emails reply** (Reply). Reply to a ShareFile EncryptedEmail by creating a new EncryptedEmail in response to the original. Returns: id, ToRecipients, CcRecipients, BccRecipients, Subject, NotifyOnUse, ExpirationDays, RequireUserInfo, RequireLogin. Required: id. This creates but does not send the reply; use the Send endpoint to send it.
- **ShareFile encrypted emails reply all** (Reply). Reply to all recipients of a ShareFile EncryptedEmail, creating a new EncryptedEmail that includes all original ToRecipients, CcRecipients, and BccRecipients. Returns: id, ToRecipients, CcRecipients, BccRecipients, Subject, NotifyOnUse, ExpirationDays, RequireUserInfo, RequireLogin. Required: id. This creates but does not send the reply.
- **ShareFile encrypted emails send** (Send). Send a ShareFile EncryptedEmail by id, providing the uploaded message body file. Returns: id, ToRecipients, CcRecipients, BccRecipients, Subject, NotifyOnUse, ExpirationDays, RequireUserInfo, RequireLogin. Required: id. Send is the final step after creating the EncryptedEmail and uploading the message body.
- **ShareFile encrypted emails upload message** (Upload). Upload a message to a ShareFile EncryptedEmail by id, preparing upload links for posting the message body. Returns an UploadSpecification with ChunkUri, FinishUri, IsResume, ResumeIndex, ResumeOffset, and ResumeFileHash. Required: id. Setting Raw to true in the body is recommended so the message body can be POSTed as a text string.
- **ShareFile encrypted emails download message** (Download). Download the message content of a ShareFile EncryptedEmail by id. When redirect is true, immediately redirects to the file download; when false, returns a DownloadSpecification with Method, Raw, FileName, and FileSize. Required: id. aliasId must be supplied when the EncryptedEmail's RequireUserInfo is true.
- **ShareFile encrypted emails bulk delete** (Delete). Delete a ShareFile EncryptedEmail by id. Access to the message and attachments via created ShareAliases will be revoked as well. Required: id. Returns an empty 204 response on success.
- **List all ShareFile favorite folders** (List). List a ShareFile user's favorite folders. Deprecated — use the Favorites API instead. Returns: Folder, FolderAlias. Required: id.
- **Get single ShareFile favorite folder by ID** (Get). Get a single ShareFile favorite folder by user and item identifiers. Deprecated — use the Favorites API instead. Returns: AccessControlType, Domains. Required: userid, itemid.
- **ShareFile favorite folders get as item** (Get). Get a ShareFile favorite folder representation of a given parent item. Deprecated — use the Favorites API instead. Returns: AccessControlType, Domains. Required: parentid.
- **ShareFile favorite folders get by composite** (Get). Get a single ShareFile favorite folder by composite user and item key. Deprecated — use the Favorites API instead. Returns: AccessControlType, Domains. Required: userid, itemid.
- **Create a ShareFile favorite folder** (Create). Add an existing ShareFile folder to a user's list of favorite folders. Deprecated — use the Favorites API instead. Returns: AccessControlType, Domains. Required: id, Folder.
- **ShareFile favorite folders create or update** (Create). Replace a ShareFile user's favorite folders with the provided list; any existing folders not included are removed. Returns the FavoriteFolder record including Folder and FolderAlias. Required: id, Folder.
- **ShareFile favorite folders bulk delete** (Delete). Delete a favorite folder from a ShareFile user's favorites list. Returns an empty 204 response on success. Required: id, itemid. This API is deprecated; use the Favorites API instead.
- **List all ShareFile favorites** (List). List all Favorite Items marked by a ShareFile user. Returns each favorite with its Item (including StreamID), Alias, and DisplayPosition. Required: id.
- **Get single ShareFile favorite by ID** (Get). Get a single Favorite Item for a ShareFile user by the item's stream id. Returns: Item, Alias, DisplayPosition. Required: userid, streamid.
- **Create a ShareFile favorite** (Create). Mark a ShareFile item as a favorite for a user. Returns the created favorite with its Item (including StreamID), Alias, and DisplayPosition. Required: userid. Alias and DisplayPosition are optional; the API assigns them if omitted.
- **ShareFile favorites replace** (Action). Replace all Favorite Items for a ShareFile user with a new list. Returns each favorite with its Item (including StreamID), Alias, and DisplayPosition. Required: userid. DisplayPosition and Alias should be unique across items.
- **ShareFile favorites bulk delete** (Delete). Remove a specific Favorite Item for a ShareFile user by stream id. Returns an empty 204 response on success. Required: userid, streamid.
- **List all ShareFile folder templates** (List). List all folder templates for the current ShareFile account. Returns: Id, Name, Description, Items.
- **Get single ShareFile folder template by ID** (Get). Get a single ShareFile folder template by id. Returns: Id, AccessControlType, Domains. Required: id.
- **Create a ShareFile folder template** (Create). Create a new ShareFile folder template with a name, description, and nested folder structure. Returns: Id, AccessControlType, Domains.
- **ShareFile folder templates bulk apply** (Action). Apply a ShareFile folder template to all subfolders of a specified folder in bulk. Returns the operation status indicating how many subfolders remain and how many subfolders are in total. Required: template_id, folder_id. batchSize controls the number of subfolders processed per batch.
- **ShareFile folder templates bulk update** (Update). Update an existing ShareFile folder template's name, description, and nested folder structure. Returns: Id, AccessControlType, Domains. Set overwrite=true to replace items with the same name instead of returning an error.
- **ShareFile folder templates bulk delete** (Delete). Delete a ShareFile folder template by id. Returns an empty 204 response on success. Required: id.
- **List all ShareFile policies** (List). List all policy definitions for the current ShareFile account. Returns: Id. These are Policy Based Administration definitions that can be assigned to users.
- **Get single ShareFile policy by ID** (Get). Get a single ShareFile policy definition by id. Returns the policy object including its Id. Required: id.
- **ShareFile policies set user policies** (Set). Replace all policies assigned to a ShareFile user. Returns the user's policy assignments including Active status and Policy Id. Required: id. At most one policy per category is allowed; omitting a category disables PBA for that category.
- **ShareFile policies create user policy** (Create). Assign a policy to a ShareFile user. Returns the newly assigned user policy including Active status and Policy Id. Required: id.
- **ShareFile policies delete user policies** (Delete). Remove a ShareFile user from policy based administration by id. Returns an empty 204 response on success. Required: id.
- **ShareFile policies delete user policy** (Delete). Delete a single policy from a ShareFile user, removing it from policy-based administration. Returns an empty 204 response on success. Required: parent_id, id.
- **ShareFile policies bulk update** (Update). Update a single user policy assigned to a ShareFile user. Currently this only allows an update to the Active flag. Returns: Active, Policy.Id. Required: parent_id, id.
- **List all ShareFile storage centers** (List). Get a single ShareFile storage center by id. Returns: id, ExternalAddress, Version, HostName. Required: id.
- **ShareFile storage centers delete direct** (Delete). Delete a ShareFile storage center by id. Returns an empty 204 response on success. Required: id.
- **ShareFile storage centers list by zone** (List). List ShareFile storage centers associated with a given zone. Returns each storage center with id, ExternalAddress, Version, and HostName. Required: id (zone identifier).
- **Create a ShareFile storage center** (Create). Create a new ShareFile storage center associated with a specific zone. Returns the created storage center including id, ExternalAddress, Version, and HostName. Required: id (zone identifier).
- **Update a ShareFile storage center by ID** (Update). Update an existing ShareFile Storage Center within a specific zone. Returns: Id, ExternalAddress, HostName, Version. Required: zid, id.
- **ShareFile storage centers get metadata** (Get). Get metadata entries associated with a specific ShareFile Storage Center. Returns: an array of metadata entries with Name, Value, and IsPublic. Required: zid, scid.
- **ShareFile storage centers create metadata** (Create). Create or update metadata entries associated with a specific ShareFile Storage Center. Returns: an array of metadata entries with Name, Value, and IsPublic. Required: zid, scid.
- **ShareFile storage centers delete metadata** (Delete). Delete a metadata entry associated with a specific ShareFile Storage Center by name. Returns an empty 204 response on success. Required: zid, scid, name.
- **ShareFile storage centers bulk update** (Update). Update a ShareFile storage center by id with modified parameters. Returns the modified storage center including id, ExternalAddress, Version, and HostName. Required: id.
- **ShareFile storage centers bulk delete** (Delete). Delete an existing ShareFile Storage Center from a zone. Returns an empty 204 response on success. Required: zid, id.
- **List all ShareFile zones** (List). List ShareFile storage zones accessible to the authenticated user, combining the account's private zones with public zones. Returns: Id, Name, HeartbeatTolerance, ZoneServices.
- **Get single ShareFile zone by ID** (Get). Get a single ShareFile storage zone by id. Returns: Id, Name, HeartbeatTolerance, ZoneServices. Required: id.
- **Create a ShareFile zone** (Create). Create a new ShareFile storage zone with a name, heartbeat tolerance, and zone services. Returns: Id, Name, HeartbeatTolerance, ZoneServices.
- **ShareFile zones reset secret** (Action). Reset a ShareFile zone's secret to a new random value. This invalidates all Storage Center communications until the Storage Center zone secret is also updated. Returns the modified zone object including Id, Name, HeartbeatTolerance, and ZoneServices. Required: id.
- **ShareFile zones get tenants** (Get). List tenant accounts assigned to a multi-tenant ShareFile zone, excluding the zone admin account. Returns: Id, Subdomain. Required: parentid.
- **ShareFile zones add tenant** (Add). Add a tenant account to a multi-tenant zone in ShareFile. Returns an empty 204 response on success. Required: parentid, accountId.
- **ShareFile zones remove tenant** (Delete). Remove a tenant account from a multi-tenant zone in ShareFile. Returns an empty 204 response on success. Required: parentid, id.
- **ShareFile zones get metadata** (Get). Get metadata associated with a specific zone in ShareFile. Returns the zone metadata feed including Name, Value, and IsPublic for each metadata entry. Required: id.
- **ShareFile zones create metadata** (Create). Create or update metadata entries for a ShareFile zone. Returns the zone metadata feed including Name, Value, and IsPublic for each entry. Required: id.
- **ShareFile zones delete metadata** (Delete). Delete a metadata entry from a ShareFile zone by metadata name. Returns an empty 204 response on success. Required: id, name.
- **ShareFile zones bulk update** (Update). Update an existing ShareFile zone by id. Returns the modified zone object including Id, Name, HeartbeatTolerance, and ZoneServices. Required: id.
- **ShareFile zones bulk delete** (Delete). Delete an existing ShareFile zone by id. Returns an empty 204 response on success. Required: id.