ShareFile
API integration

list_all_share_file_items

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_share_file_item_by_id

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,…

share_file_items_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.

share_file_items_get_by_path

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_share_file_item_by_id

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_share_file_item

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.

share_file_items_get_treeview

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.

share_file_items_get_stream

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).

share_file_items_get_by_relative_path

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.

share_file_items_get_parent

Get the parent Item of a ShareFile item by id. Returns the parent Item including Id, Name, Description, FileName, ExpirationDate, and StreamID. Required: id.

share_file_items_get_children

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.

share_file_items_get_info

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,…

share_file_items_bulk_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).

share_file_items_create_note

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.

share_file_items_create_link

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.

share_file_items_create_symbolic_link

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.

share_file_items_update_link

Update a ShareFile Link by id, optionally sending notifications to folder listeners. Returns: Id, Name, Uri, Description, Parent. Required: id.

share_file_items_update_note

Update a Note in ShareFile by id. Returns the modified Note object including its Id, Name, Description, and Parent. Required: id.

share_file_items_update_symbolic_link

Update a Symbolic Link in ShareFile by id. Returns the modified SymbolicLink object including its Name, Description, Link, Zone, and ConnectorGroup. Required: id.

share_file_items_bulk_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.

share_file_items_get_thumbnail

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.

share_file_items_get_breadcrumbs

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.

share_file_items_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.

share_file_items_check_in

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).

share_file_items_check_out

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).

share_file_items_discard_check_out

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.

share_file_items_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.

share_file_items_search_in_folder

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.

share_file_items_advanced_simple_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.

share_file_items_advanced_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…

share_file_items_get_web_view

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.

share_file_items_get_protocol_links

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.

share_file_items_get_redirection

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.

share_file_items_get_deleted_children

List recoverable/deleted items inside a specific ShareFile folder. Returns: Id, Name, Description, Zone, ExpirationDate, Uri, Link, ConnectorGroup. Required: parentid.

share_file_items_get_user_deleted_items

List recoverable/deleted items for a specific ShareFile user. Returns: Id, Name, Description, Zone, ExpirationDate, Uri, Link, ConnectorGroup. Required: userid.

share_file_items_bulk_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.

share_file_items_bulk_delete_permanently

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.

share_file_items_create_web_app_link

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.

share_file_items_remove_template_association

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.

share_file_items_check_template_owned

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.

share_file_items_check_versioning_violation

Check if a versioning change on a ShareFile folder would result in file deletions. Required: parentid, newMaxVersions. Returns an empty 204 response on success.

share_file_items_check_if_previewable

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.

share_file_items_get_by_dlp_status

Get ShareFile items filtered by Data Loss Prevention scan status. Returns: Id, Name, FileName, Description, CreationDate, ExpirationDate, Zone, Parent. Required: status.

share_file_items_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).

share_file_items_upload_2

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.

share_file_items_bulk_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_share_file_shares

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_share_file_share_by_id

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_share_file_share

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.

share_file_shares_get_recipient

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.

share_file_shares_get_item

Get a single Item within a Send Share in ShareFile. Returns: Id, Name, Description, Zone, ExpirationDate, Uri, Link, ConnectorGroup. Required: shareid, itemid.

share_file_shares_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.

share_file_shares_upload_prepare

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).

share_file_shares_get_recipients

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.

share_file_shares_create_recipient

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.

share_file_shares_get_items

List the items (files and folders) contained in a ShareFile send share. Returns: Name, Description, Zone, ExpirationDate, Uri, Link, ConnectorGroup. Required: id.

share_file_shares_get_item_thumbnail

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.

share_file_shares_get_item_protocol_links

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).

share_file_shares_download_with_alias

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.

share_file_shares_bulk_download_with_alias

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.

share_file_shares_create_alias

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.

share_file_shares_delete_alias

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.

share_file_shares_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.

share_file_shares_send_callback

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.

share_file_shares_request

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.

share_file_shares_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.

share_file_shares_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).

share_file_shares_get_redirection

Get the redirection endpoint information for a specific ShareFile share. Returns the redirection endpoint information for the share. Required: id.

share_file_shares_get_inbox

Retrieve all outstanding ShareFile shares in the inbox. Returns a list of share objects including Id, ShareType, Title, Items, Recipients, ExpirationDate, and RequireLogin.

share_file_shares_get_inbox_for_user

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.

share_file_shares_get_message

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.

share_file_shares_bulk_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.

share_file_shares_bulk_delete

Delete an existing ShareFile share by id. Returns an empty 204 response on success. Required: id.

list_all_share_file_users

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_share_file_user_by_id

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_share_file_user

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.

share_file_users_create_for_folder

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.

share_file_users_create_employee

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.

share_file_users_update_roles

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.

share_file_users_set_roles

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.

share_file_users_remove_roles

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.

share_file_users_update_employee

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.

share_file_users_get_home_folder

Get a ShareFile user's home folder by user id. Returns the folder object including Id, Name, Description, and ExpirationDate. Required: id.

share_file_users_get_top_folders

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.

share_file_users_get_box

Get a ShareFile user's FileBox children by user id. Returns a collection of Item objects, each with Id, FileName, and FileSizeBytes. Required: id.

share_file_users_get_preferences

Get a ShareFile user's preferences record by user id. Returns: EnableFlashUpload, EnableJavaUpload, .... Required: id.

share_file_users_update_preferences

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.

share_file_users_get_security

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.

share_file_users_reset_password

Reset the current user's password in ShareFile. Returns the modified user record including Email, FirstName, LastName, Company, DefaultZone, and Roles. Required: NewPassword, OldPassword.

share_file_users_forgot_password

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.

share_file_users_resend_welcome

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.

share_file_users_welcome_notification

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.

share_file_users_delete_clients

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.

share_file_users_bulk_delete_clients

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.

share_file_users_downgrade_employees

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.

share_file_users_get_all_shared_folders

List shared folders a specified ShareFile user has access to. Returns Folder objects including Id, Name, Description, Zone, and ExpirationDate. Required: userid.

share_file_users_get_top_level_folders

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).

share_file_users_get_sharepoint_connectors

List SharePoint connector folders accessible to the authenticated ShareFile user. Returns a list of Folder objects with id, name, description.

share_file_users_confirm

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.

share_file_users_get_info

Get information about the currently authenticated ShareFile user. Returns the User object including Email, FirstName, LastName, Company, DefaultZone, Security, IsAdministrator, CanManageUsers, and Roles.

share_file_users_delete_email_address

Delete an email address from a ShareFile user. Returns the updated User object including Email, FirstName, LastName, Company, DefaultZone, and Security. Required: email.

share_file_users_make_primary_email

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.

share_file_users_send_confirmation_email

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.

share_file_users_send_email_verification_code

Send an email verification code to a user's email address in ShareFile. Returns an empty 204 response on success. Required: email.

share_file_users_send_marketing_verification_code

Send an email verification code for a marketing email address in ShareFile. Returns a ResponseWrapper containing an EmailVerificationCodeMarketingData object. Required: email.

share_file_users_verify_email_address

Verify a user's email address by verification code in ShareFile. Returns an empty 204 response on success. Required: email, verificationCode.

share_file_users_create_web_app_link

Create a one-time use login URI for the ShareFile Web App. Returns a Redirection object populated with a link in the Uri field.

share_file_users_get_inbox_metadata

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.

share_file_users_get_inbox

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.

share_file_users_get_sent_messages

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.

share_file_users_create_web_app_manage_user

Create a one-time use login URI for the ShareFile Web App for a specific user. Returns: Uri. Required: user_id.

share_file_users_create_web_app_manage_users

Create a one-time use login URI for the ShareFile Web App for managing users. Returns: Uri.

share_file_users_create_web_app_add_employee

Create a one-time use login URI for the ShareFile Web App for adding a new employee. Returns: Uri.

share_file_users_bulk_update

Update an existing ShareFile user by id. Modifies FirstName, LastName, Company, Email, Security.IsDisabled, DefaultZone Id, StorageQuotaLimitGB, and Bandwidth. Returns: Id. Required: id.

share_file_users_bulk_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_share_file_groups

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_share_file_group_by_id

Get a single ShareFile group by id. Returns: Id, Name, IsShared, Contacts, odata.metadata.metadata. Required: id.

create_a_share_file_group

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.

share_file_groups_add_contacts

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.

share_file_groups_remove_contacts

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.

share_file_groups_get_contacts

List the contacts (members) of a ShareFile group. Returns: Id, Email. Required: id.

share_file_groups_export_document

Export the contacts of a ShareFile group as a spreadsheet or CSV file. Returns a file download with content-type-specific content. Required: id.

share_file_groups_get_for_user

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.

share_file_groups_bulk_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.

share_file_groups_bulk_delete

Delete a ShareFile group by id. Returns an empty 204 response on success. Required: id.

list_all_share_file_reports

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_share_file_report_by_id

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_share_file_report

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.

share_file_reports_run

Run a ShareFile report by id and get the run id. Returns: Id. Required: id.

share_file_reports_get_recent

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.

share_file_reports_get_recurring

List all recurring reports for the current ShareFile account. Returns: Id, Title, ReportType, ActivityTypes, ObjectType, ObjectId, DateOption, SaveFormat, IsRecurring, IsScheduled, Frequency.

share_file_reports_get_record

Get a single report record by id in ShareFile. Returns: Id, Title, ReportType, ActivityTypes, ObjectType, ObjectId, DateOption, SaveFormat, IsRecurring, IsScheduled, Frequency. Required: id.

share_file_reports_get_records

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.

share_file_reports_preview

Get a preview location for a ShareFile report. Returns: Title, ReportType, SaveFormat, Frequency, IsRecurring, IsScheduled. Required: report_id.

share_file_reports_get_json_data

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.

share_file_reports_move

Move a ShareFile report to a target folder location. Required: report_id, folder_id. Returns an empty 204 response on success.

share_file_reports_download_data

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.

share_file_reports_bulk_update

Update an existing ShareFile report with partial Report model fields. Returns the updated report including Title, ReportType, IsRecurring, IsScheduled, and Frequency.

share_file_reports_bulk_delete

Delete a ShareFile report by id. Returns an empty 204 response on success. Required: id.

list_all_share_file_workflows

List ShareFile workflows. Returns a feed of Workflow objects including Id, Participants, LastUpdatedDate, and Due. Supports OData $filter and $orderby query parameters.

get_single_share_file_workflow_by_id

Get a single ShareFile workflow by id. Returns the Workflow object including Id, Participants, LastUpdatedDate, and Due. Required: id.

create_a_share_file_workflow

Create a new ShareFile workflow with the specified participants. Returns the created Workflow object including Id, Participants, LastUpdatedDate, and Due. Required: Participants.

share_file_workflows_get_initiated

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.

share_file_workflows_get_shared

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.

share_file_workflows_get_link

Get a protocol link to view a ShareFile workflow in a web browser. Returns: Name, Description, Uri. Required: id.

share_file_workflows_create_approval

Create an approval workflow on a ShareFile item. Returns the new workflow including Id, LastUpdatedDate, Due, Participants. Required: id, Participants.

share_file_workflows_create_feedback

Create a feedback workflow on a ShareFile item. Returns the new workflow including Id, LastUpdatedDate, Due, Participants. Required: id, Participants.

share_file_workflows_bulk_update

Update a ShareFile workflow by id. Returns the updated workflow object including its id and Participants with Contact email and Role. Required: id.

share_file_workflows_bulk_delete

Delete a ShareFile workflow by id. Returns an empty 204 response on success. Required: id.

list_all_share_file_webhook_subscriptions

List all webhook subscriptions for the current ShareFile user. Returns: Id, SubscriptionContext, WebhookUrl, Events.

get_single_share_file_webhook_subscription_by_id

Get a single webhook subscription in ShareFile by id. Returns: Id, SubscriptionContext, WebhookUrl, Events. Required: id.

create_a_share_file_webhook_subscription

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.

share_file_webhook_subscriptions_bulk_delete

Delete a webhook subscription in ShareFile by id. Returns an empty 204 response on success. Required: id.

list_all_share_file_webhook_clients

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_share_file_webhook_client_by_id

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_share_file_webhook_client

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.

share_file_webhook_clients_generate_primary_key

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.

share_file_webhook_clients_generate_secondary_key

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.

share_file_webhook_clients_bulk_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.

share_file_webhook_clients_bulk_delete

Delete a ShareFile webhook client configuration by id. Returns an empty 204 response on success. Required: id.

share_file_sessions_logout

Logout the current ShareFile session by invalidating the current Session ID. Returns an empty 204 response on success.

share_file_sessions_login

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.

share_file_sessions_acs

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_share_file_accounts

Get the current ShareFile account information for the authenticated subdomain. Returns: Id, Name, odata.metadata, AccessControlType, Domains.metadata.

share_file_accounts_get_by_id

Get a single ShareFile account by id. Returns the subdomain account information including id and subdomain. Required: id.

share_file_accounts_get_branding

Get branding information for the current ShareFile subdomain account. Returns: attributes, UsernameShort, Password, EmployeeOnly. This operation does not require authentication.

share_file_accounts_get_employees

List employees (named users) in the current ShareFile account. Returns: Id, Email, FirstName, LastName, Company. Optional: withRightSignature to filter employees with the CanSendDocumentsForSignature role.

share_file_accounts_get_clients

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.

share_file_accounts_get_address_book

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.

share_file_accounts_get_mobile_security

Get the mobile device security configuration settings for the current ShareFile account. Returns: UsernameShort, Password, EmployeeOnly, AccessControlType, Domains. No required parameters.

share_file_accounts_get_product_defaults

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.

share_file_accounts_get_preferences

Get the current ShareFile account preferences. Returns: EnableDLP, PasswordPolicy, UsernameShort, Password, EmployeeOnly.

share_file_accounts_update_preferences

Update ShareFile account preferences including DLP enablement and password policy settings. Returns: EnableDLP, PasswordPolicy, UsernameShort, Password, EmployeeOnly.

share_file_accounts_get_sso

Get the Single Sign-On (SSO) configuration for the current ShareFile account. Returns: AccessControlType, Domains.

share_file_accounts_update_sso

Update the Single Sign-On (SSO) configuration for the current ShareFile account. Returns: LogoutUrl, LoginUrl, IPRestrictions, ForceSSO, EntityID, SFEntityID, SPInitatedAuthContext, SPInitatedAuthMethod, AccessControlType, Domains.

share_file_accounts_send_to_email

Send the list of ShareFile accounts associated with a user to a specified email address. Required: email. Returns an empty 204 response on success.

share_file_accounts_get_login_access_control_domains

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.

share_file_accounts_get_folder_access_control_domains

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.

share_file_accounts_create_login_access_control_domains

Create or replace the login access control list of domains for the ShareFile account. Returns: AccessControlType, Domains. Required: AccessControlType, Domains.

share_file_accounts_create_folder_access_control_domains

Create or replace the folder access control list of domains for the ShareFile account. Returns: AccessControlType, Domains. Required: AccessControlType, Domains.

share_file_accounts_update_login_access_control_domains

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.

share_file_accounts_update_folder_access_control_domains

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.

share_file_accounts_delete_login_access_control_domains

Delete specified domains from the Login Access Control List for a ShareFile account. Returns an empty 204 response on success. Required: Domains.

share_file_accounts_delete_folder_access_control_domains

Delete domains from the Folder Access Control List in ShareFile. Returns an empty 204 response on success. Required: AccessControlType, Domains.

share_file_accounts_require_web_pop

Check whether a web popup (WebPop) is required for a ShareFile account during authentication. Returns a RequireWebPopResult object. Required: subdomain, username.

share_file_accounts_require_subdomain

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.

share_file_accounts_find_subdomain

Find the ShareFile user account subdomain based on a short username. Returns: UsernameShort, Password, EmployeeOnly. Required: UsernameShort, Password.

share_file_accounts_get_outlook_info

Get Outlook integration information for the current ShareFile account. Returns: AccessControlType, Domains. No required parameters.

share_file_accounts_get_sso_info

Get Single Sign-On information for a ShareFile account by subdomain. Returns: UsernameShort, Password, EmployeeOnly. Required: subdomain.

share_file_accounts_get_tenants

List the tenant accounts managed by a partner account in ShareFile. Returns: id, subdomain, and disk space information for each tenant account.

share_file_accounts_get_tenant

Get a specific ShareFile tenant account by id. Returns the tenant account object. Required: id.

share_file_accounts_get_tenant_zone_usage

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.

share_file_accounts_get_tenant_zones

List the multi-tenant zones assigned to a ShareFile tenant account. Returns: Id, Name, HeartbeatTolerance, ZoneServices. Required: parent_id.

share_file_accounts_create_web_app_admin

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.

share_file_accounts_bulk_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.

share_file_metadata_list_by_item

List metadata entries for a specific ShareFile item. Returns: Name, Value, IsPublic. Required: id.

create_a_share_file_metadatum

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.

share_file_metadata_update_by_name

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_share_file_metadatum_by_id

Update a single ShareFile metadata entry identified by metadata name and item id. Returns: Name, Value. Required: name, itemid, Value.

share_file_metadata_bulk_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.

share_file_metadata_delete_by_name

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.

share_file_metadata_bulk_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_share_file_access_controls

List all access controls in ShareFile. Returns the access control object including Principal, CanUpload, CanDownload, CanView, CanDelete, CanManagePermissions, CanCreate, CanManage, Message, and Item.

share_file_access_controls_list_by_item

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_share_file_access_control

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_share_file_access_control_by_id

Delete a ShareFile AccessControl entry by principal ID and item ID. Returns an empty 204 response on success. Required: principalid, itemid.

share_file_access_controls_bulk_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.

share_file_access_controls_bulk_set_for_principal

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.

share_file_access_controls_clone

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.

share_file_access_controls_bulk_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.

share_file_access_controls_bulk_delete_for_principal

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.

share_file_access_controls_notify_users

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.

share_file_access_controls_notify_users_preview

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.

share_file_access_controls_bulk_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_share_file_apps

List ShareFile apps authorized for the current user. Returns a feed of ConnectedApp objects, each with id. No required parameters.

share_file_apps_list_for_user

List ShareFile apps authorized for a specific user. Returns a feed of ConnectedApp objects, each with id. Required: id.

get_single_share_file_app_by_id

Get a single ShareFile app by id. Returns the ConnectedApp object with id. Required: id.

share_file_apps_get_for_user

Get a single ShareFile app for a specific user. Returns the ConnectedApp object with id. Required: id, appid.

share_file_apps_delete_for_user

Revoke a connected app's access for a given ShareFile user. Returns an empty 204 response on success. Required: id, appid.

share_file_apps_list_tfa

List all Two Factor Authentication apps for the current ShareFile user. Returns a feed of TwoFactorAuthApp objects including their Id.

share_file_apps_list_tfa_for_user

List all Two Factor Authentication apps for a given ShareFile user. Returns a feed of TwoFactorAuthApp objects including their Id. Required: id.

share_file_apps_get_tfa

Get a single Two Factor Authentication app for the current ShareFile user by id. Returns: id, attributes. Required: id.

share_file_apps_get_tfa_for_user

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.

share_file_apps_delete_tfa

Revoke a two-factor authentication app for the current ShareFile user by app ID. Returns an empty 204 response on success. Required: id.

share_file_apps_delete_tfa_for_user

Revoke a two-factor authentication app for a specific ShareFile user. Returns an empty 204 response on success. Required: id, tfa_app_id.

share_file_apps_bulk_delete

Revoke a ShareFile app's access for the current user by id. Returns an empty 204 response on success. Required: id.

list_all_share_file_async_operations

Get a single ShareFile async operation by id. Returns: id, State. Required: id.

share_file_async_operations_get_by_batch

List all ShareFile async operations belonging to a specified operation batch. Returns: id, State. Required: id.

share_file_async_operations_get_batch_progress

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).

share_file_async_operations_get_by_folder

List ShareFile AsyncOperations associated with a specific folder by source Item ID. Returns: odata.metadata, odata.count, value.count, odata.metadata. Required: id.

share_file_async_operations_cancel

Cancel a single ShareFile async operation by id. Returns the modified async operation record including its id and State. Required: id.

share_file_async_operations_cancel_batch

Cancel an Async Operation batch in ShareFile, moving all unfinished Async Operation records in the batch to Cancelled state. Returns: id, State. Required: id.

share_file_async_operations_bulk_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.

share_file_async_operations_bulk_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_share_file_capabilities

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_share_file_connector_groups

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_share_file_connector_group_by_id

Get a single ShareFile Connector Group by its Service identifier. Returns: Id, Name, Provider, Zones. Required: id.

share_file_connector_groups_get_by_provider

Get a single ShareFile Connector Group by its provider name. Returns: Id, Name, Provider, Zones. Required: provider.

share_file_connector_groups_get_zone

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.

share_file_connector_groups_get_access_control

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.

share_file_connector_groups_get_by_zone

Get ShareFile connector groups defined in a specific zone. Returns: Id, Name, Provider, Zones. Required: zoneid.

create_a_share_file_connector_group

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.

share_file_connector_groups_add_zone

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.

share_file_connector_groups_add_access_control

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.

share_file_connector_groups_delete_zone

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.

share_file_connector_groups_delete_access_control

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.

share_file_connector_groups_get_storage_centers

List Storage Centers associated with a ShareFile Connector Group zone. Returns: Id, ExternalAddress, HostName, Version. Required: id, zoneid.

share_file_connector_groups_add_storage_center

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.

share_file_connector_groups_bulk_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.

share_file_connector_groups_bulk_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_share_file_devices

List ShareFile device users for the current user. Returns a feed of DeviceUser objects including id, created_at, updated_at.

get_single_share_file_device_by_id

Get a single ShareFile device by id. Returns the device object including id, created_at, updated_at. Required: id.

share_file_devices_list_for_user

List devices for a given ShareFile user. Returns a list of device objects including id, created_at, updated_at. Required: id.

share_file_devices_wipe

Wipe a ShareFile device remotely, removing all ShareFile data from it. Returns an empty 204 response on success. Required: device_id.

share_file_devices_lock

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.

share_file_devices_unlock

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.

share_file_devices_bulk_delete

Delete a specific device for a given ShareFile user. Returns an empty 204 response on success. Required: parentid, id.

share_file_encrypted_emails_authorize

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_share_file_encrypted_emails

Get a ShareFile encrypted email by id. Returns: id, ToRecipients, CcRecipients, BccRecipients, Subject, NotifyOnUse, ExpirationDays, RequireUserInfo, RequireLogin. Required: id.

share_file_encrypted_emails_get_thread

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.

share_file_encrypted_emails_get_by_share

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_share_file_encrypted_email

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.

share_file_encrypted_emails_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.

share_file_encrypted_emails_reply_all

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.

share_file_encrypted_emails_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.

share_file_encrypted_emails_upload_message

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.

share_file_encrypted_emails_download_message

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.

share_file_encrypted_emails_bulk_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_share_file_favorite_folders

List a ShareFile user's favorite folders. Deprecated — use the Favorites API instead. Returns: Folder, FolderAlias. Required: id.

get_single_share_file_favorite_folder_by_id

Get a single ShareFile favorite folder by user and item identifiers. Deprecated — use the Favorites API instead. Returns: AccessControlType, Domains. Required: userid, itemid.

share_file_favorite_folders_get_as_item

Get a ShareFile favorite folder representation of a given parent item. Deprecated — use the Favorites API instead. Returns: AccessControlType, Domains. Required: parentid.

share_file_favorite_folders_get_by_composite

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_share_file_favorite_folder

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.

share_file_favorite_folders_create_or_update

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.

share_file_favorite_folders_bulk_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_share_file_favorites

List all Favorite Items marked by a ShareFile user. Returns each favorite with its Item (including StreamID), Alias, and DisplayPosition. Required: id.

get_single_share_file_favorite_by_id

Get a single Favorite Item for a ShareFile user by the item's stream id. Returns: Item, Alias, DisplayPosition. Required: userid, streamid.

create_a_share_file_favorite

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.

share_file_favorites_replace

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.

share_file_favorites_bulk_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_share_file_folder_templates

List all folder templates for the current ShareFile account. Returns: Id, Name, Description, Items.

get_single_share_file_folder_template_by_id

Get a single ShareFile folder template by id. Returns: Id, AccessControlType, Domains. Required: id.

create_a_share_file_folder_template

Create a new ShareFile folder template with a name, description, and nested folder structure. Returns: Id, AccessControlType, Domains.

share_file_folder_templates_bulk_apply

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.

share_file_folder_templates_bulk_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.

share_file_folder_templates_bulk_delete

Delete a ShareFile folder template by id. Returns an empty 204 response on success. Required: id.

list_all_share_file_policies

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_share_file_policy_by_id

Get a single ShareFile policy definition by id. Returns the policy object including its Id. Required: id.

share_file_policies_set_user_policies

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.

share_file_policies_create_user_policy

Assign a policy to a ShareFile user. Returns the newly assigned user policy including Active status and Policy Id. Required: id.

share_file_policies_delete_user_policies

Remove a ShareFile user from policy based administration by id. Returns an empty 204 response on success. Required: id.

share_file_policies_delete_user_policy

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.

share_file_policies_bulk_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_share_file_storage_centers

Get a single ShareFile storage center by id. Returns: id, ExternalAddress, Version, HostName. Required: id.

share_file_storage_centers_delete_direct

Delete a ShareFile storage center by id. Returns an empty 204 response on success. Required: id.

share_file_storage_centers_list_by_zone

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_share_file_storage_center

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_share_file_storage_center_by_id

Update an existing ShareFile Storage Center within a specific zone. Returns: Id, ExternalAddress, HostName, Version. Required: zid, id.

share_file_storage_centers_get_metadata

Get metadata entries associated with a specific ShareFile Storage Center. Returns: an array of metadata entries with Name, Value, and IsPublic. Required: zid, scid.

share_file_storage_centers_create_metadata

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.

share_file_storage_centers_delete_metadata

Delete a metadata entry associated with a specific ShareFile Storage Center by name. Returns an empty 204 response on success. Required: zid, scid, name.

share_file_storage_centers_bulk_update

Update a ShareFile storage center by id with modified parameters. Returns the modified storage center including id, ExternalAddress, Version, and HostName. Required: id.

share_file_storage_centers_bulk_delete

Delete an existing ShareFile Storage Center from a zone. Returns an empty 204 response on success. Required: zid, id.

list_all_share_file_zones

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_share_file_zone_by_id

Get a single ShareFile storage zone by id. Returns: Id, Name, HeartbeatTolerance, ZoneServices. Required: id.

create_a_share_file_zone

Create a new ShareFile storage zone with a name, heartbeat tolerance, and zone services. Returns: Id, Name, HeartbeatTolerance, ZoneServices.

share_file_zones_reset_secret

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.

share_file_zones_get_tenants

List tenant accounts assigned to a multi-tenant ShareFile zone, excluding the zone admin account. Returns: Id, Subdomain. Required: parentid.

share_file_zones_add_tenant

Add a tenant account to a multi-tenant zone in ShareFile. Returns an empty 204 response on success. Required: parentid, accountId.

share_file_zones_remove_tenant

Remove a tenant account from a multi-tenant zone in ShareFile. Returns an empty 204 response on success. Required: parentid, id.

share_file_zones_get_metadata

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.

share_file_zones_create_metadata

Create or update metadata entries for a ShareFile zone. Returns the zone metadata feed including Name, Value, and IsPublic for each entry. Required: id.

share_file_zones_delete_metadata

Delete a metadata entry from a ShareFile zone by metadata name. Returns an empty 204 response on success. Required: id, name.

share_file_zones_bulk_update

Update an existing ShareFile zone by id. Returns the modified zone object including Id, Name, HeartbeatTolerance, and ZoneServices. Required: id.

share_file_zones_bulk_delete

Delete an existing ShareFile zone by id. Returns an empty 204 response on success. Required: id.