Files.com - Partner operation
The Files.com operation defines the action that your process step will perform on the Files.com site.
Create a separate operation component for each action that you wish to perform.
The Files.com connector provides the following actions for use in your Boomi processes:
- Copy
- Create
- Delete
- Download
- List
- Move
- Show
- Update
- Upload
- Download a file*
- List folder items*
- Upload a file*
*Download a file, List Folder items, and Upload a file are deprecated but remain for backwards compatibility.
Actions
Copy
This operation will make a copy of a file or folder in your Files.com site. This is an asynchronous operation which is performed as a background process. The status of this background process should be checked, to confirm that the process has been completed, prior to attempting any actions on the result of the copy.
When creating a new Files.com Connector Operation, select a Connection component, select the Connector Action for Copy, and select a Connector Operation component.
When creating a new Connector Operation component, select the Import Operation button, and use the Import Wizard to complete the import. A Request Profile will be created for you. The Copy action does not create a Response Profile.
After the operation import, the following parameters will be available for the connector step:
-
destination: (Required) The destination path to be copied to. This should be the full absolute path. Include the file name and file extension when specifying a file.
-
path: (Required) The path to the file or folder to be copied. This should be the full absolute path to the file or folder.
The response to this action, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| file_migration_id | String | The ID of the background File Migration operation. |
| status | String | The status of the File Migration operation. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
Create
This operation will create an item in your Files.com site. Details about the created item will be included in the response.
When creating a new Files.com Connector Operation, select a Connection component, select the Connector Action for Create, and select a Connector Operation component.
When creating a new Connector Operation component, select the Import Operation button, use the Import Wizard to complete the import. Select the Object Type of the item that you wish to create:
- Folder
- Group
- ShareLink
- ShareLinkNotification
- ShareLinkRecipient
- User
A Request Profile will be created for you. The Create action does not create a Response Profile.
Folder
This operation will create a new folder in your Files.com site. Details about the created folder are included in the response.
After the operation import, the following Parameters will be available for the connector step:
- path: (Required) The path of the folder to be created. This should be the full absolute path. The response to this action, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| created_at | Int64 | The date and time that the folder was created, in Unix (Epoch) Time format. |
| display_name | String | The name of the file or folder, as displayed to the user. |
| is_locked | Boolean | Specifies whether a folder is locked and cannot be modified. |
| subfolders_locked | Boolean | Specifies whether subfolders are locked and cannot be modified. |
| type | String | The type of the item, either directory or file. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
Group
This operation will create a new group in your Files.com site. Details of the created group are included in the response.
After the operation import, the following Parameters will be available for the connector step:
- admin_ids: (Optional) A comma-delimited list of User IDs. These users will have administration privileges for this group.
- name: (Required) A name for the group.
- notes: (Optional) An internal note about the group. This note can be viewed by administrators of your Files.com site.
- user_ids: (Optional) A comma-delimited list of User IDs. These users will become members of the group.
The response to this action, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| admin_ids | String | A comma-delimited list of User IDs. These users have administration privileges for this group. |
| dav_permission | Boolean | Specifies if members of this group are allowed to use the WebDAV protocol to connect to Files.com. |
| ftp_permission | Boolean | Specifies if members of this group are allowed to use the FTP protocol to connect to Files.com. This includes the use of FTPS (Implicit) and FTPS (Explicit) variations of FTP. |
| id | Int64 | The unique ID of the group. |
| name | String | The name of the group. |
| notes | String | Internal notes about the group. |
| restapi_permission | Boolean | Specifies if members of this group are allowed to use the Files.com web portal, or the Files.com REST APIs, to connect to Files.com. |
| sftp_permission | Boolean | Specifies if members of this group are allowed to use the SFTP protocol to connect to Files.com. |
| user_ids | String | A comma-delimited list of User IDs. These users are members of this group. |
| usernames | String | A comma-delimited list of user names, corresponding with the User IDs above. The above values can be queried, and the results used in subsequent steps of your Boomi process. |
ShareLink
This operation will create a new secure share link which recipients can use to securely download files and folders from your Files.com site. Details of the created share link are included in the response.
After the operation import, the following Parameters will be available for the connector step:
- description: (Optional) The public description for the share link. This is shown to visitors of the link.
- expires_at: (Optional) The expiration date and time for the share link. The link will not be available to visitors after this date and time. The date and time should be entered in Coordinated Universal Time (UTC) using
yyyyMMdd HHmmss.SSSformatting. For example:20240502 174500.000 - max_uses: (Optional) The maximum number of times that the share link can be used by visitors. The link will no longer be usable once this number of uses has been met.
- note: (Optional) An internal note for the share link. This note can be viewed by administrators of your Files.com site.
- password: (Optional) The password for the share link. The contents of the share link can only be accessed if the visitor provides this password. If a password is specified here then your process should also include steps to securely provide you, or your share link visitors, with this password.
- paths: (Required) An array of paths to files and folders that will be accessible using the share link. Each array element will represent a path. Visitors to the share link will be able to access and download these items. Paths are relative to the root folder of your Files.com site. For example:
path/to/file.txt - require_registration: (Optional) Specifies if visitors to the share link must provide their name, email, and company name prior to accessing the contents of the link. Registration information entered by the visitor is saved and can be accessed using the List operation for ShareLinkRegistrations. Provide a value of
trueorfalse.
The response to this action, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| code | String | The share link code. This is used as the suffix of the link URL. |
| created_at | Date-Time | Specifies the creation date/time of the share link, in Unix (Epoch) Time format. |
| description | String | Public description of the share link. |
| dont_separate_submissions_by_folder | Boolean | Prevents submissions to the share link from being separated into sub-folders. Not recommended as duplicate submissions can cause overwriting of files. |
| expires_at | Date-Time | The date/time of when access to the share link expires. |
| has_inbox | Boolean | Specifies whether the share link has an associated inbox. |
| id | Int64 | The unique ID of the share link. |
| max_uses | Int64 | The maximum number of times that the share link can be used. |
| note | String | Internal note for the share link. |
| password_protected | Boolean | Specifies whether the share link is password protected. |
| paths | Array | Array of paths to files and folders that will be accessible using the share link |
| permissions | String | Specifies the access permissions for folders contained in the share link. Possible values: read, write, read_write, full, none, preview_only |
| require_logout | Boolean | Specifies whether the share link registration page should remove the Remember Me option so that each visit is considered a new login session by visitors. |
| require_registration | Boolean | Specifies whether the share link should present a registration page to capture visitor information. |
| require_share_recipient | Boolean | Specifies whether the share link can only be used by recipients who have explicitly received the link via an email sent from Files.com. |
| send_email_receipt_to_uploader | Boolean | Specifies whether to send a delivery receipt email to the uploader. Only applies to share links that have write permission. |
| skip_company | Boolean | Specifies whether the default registration form should omit asking for a visitor company name. |
| skip_email | Boolean | Specifies whether the default registration form should omit asking for a visitor email. |
| skip_name | Boolean | Specifies whether the default registration form should omit asking for a visitor name. |
| url | String | Public URL of the share link. |
| user_id | Int64 | The User ID of the user that created the share link. |
| username | String | The username of the user account that created the share link. |
The above values can be queried, and the results used in subsequent steps of your Boomi process. The returned url value is the link that should be provided to recipients.
ShareLinkNotification
This operation will create a new notification for a specific share link. Details of the created notification are included in the response.
After the operation import, the following Parameters will be available for the connector step:
- bundle_id: (Required) The ID of the share link.
- user_id: (Required) The User ID of the user that will receive the notification.
The response to this action, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| bundle_id | Int64 | The ID of the share link that this notification is associated with. |
| id | Int64 | The ID of the share link notification. |
| notify_on_registration | Boolean | Specifies whether the notification is triggered by a registration occurring. |
| notify_on_upload | Boolean | Specifies whether the notification is triggered when an upload to the share link occurs. |
| user_id | Int64 | The User ID of the user that will receive the notification. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
ShareLinkRecipient
This operation will create a new recipient for a specific share link. Details of the created recipient are included in the response.
After the operation import, the following Parameters will be available for the connector step:
- bundle_id - (Required) The ID of the share link.
- company - (Optional) The company name of the user.
- name - (Optional) The full name of the user.
- note - (Optional) A note that will be sent within the email to the recipient.
- recipient - (Required) The email address of the recipient.
The response to this action, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| company | String | The company name for the user. |
| name | String | The full name of the recipient. |
| note | String | Note sent to the recipient. |
| recipient | String | The email address of the recipient. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
User
This operation will create a new user account in your Files.com site. Details of the created user account are included in the response.
After the operation import, the following Parameters will be available for the connector step:
- authentication_method - (Optional) Specifies the method that is used to authenticate the user. Select between assigning a password or sending an email to the user to allow them to set up their own password. When setting this option using a Dynamic Operation Property, provide a value of password or email_signup.
- company - (Optional) The company name of the user.
- email - (Optional) The email address of the user.
- group_ids - (Optional) A comma-delimited list of Group IDs that this user will become a member of.
- name - (Optional) The full name of the user.
- notes - (Optional) An internal note about the user account. This note can be viewed by administrators of your Files.com site.
- password - (Optional) The password for the user account.
- require_password_change - (Optional) Specifies whether the user must change their password on their next login. When setting this option using a Dynamic Operation Property provide a value of true or false.
- user_root - (Optional) Root folder for FTP, and optionally SFTP if the corresponding site-wide setting is set, for the user account. This is not used for API, Desktop, or Web interface based access.
- username - (Required) The login username for the user.
The response to this action, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| active_2fa | Boolean | Specifies whether 2FA is enabled for the user. |
| admin_group_ids | String | A comma-delimited list of Group IDs of which the user has administration privileges for. |
| allowed_ips | String | A list of allowed IP addresses that this user can connect to your Files.com site from. |
| api_keys_count | Int64 | Number of API keys associated with this user. |
| authenticate_until | Date-Time | Scheduled date/time at which user will be deactivated. |
| authentication_method | String | The method that is used to authenticate the user. |
| avatar_url | String | URL to the user’s avatar image file. |
| billing_permission | Boolean | Specifies whether the user can access payment, invoice, and billing areas of your Files.com site. |
| bypass_site_allowed_ips | Boolean | Specifies whether the user can bypass the list of denied IP addresses of your Files.com site. |
| bypass_inactive_disable | Boolean | Specifies whether the user is exempt from being disabled due to inactivity. |
| company | String | The company name for the user. |
| created_at | Date-Time | Creation date/time of the user account. |
| dav_permission | Boolean | Specifies whether the user is allowed to use the WebDAV protocol to connect to Files.com. |
| days_remaining_until_password_expire | Int64 | Number of days remaining until the password expires for the user. |
| disabled | Boolean | Specifies whether the user account is disabled. |
| The email address of the user. | ||
| externally_managed | Boolean | Specifies whether the user account is managed by a SSO system integrated with your Files.com site. |
| first_login_at | Date-Time | The date/time of the first login by the user. |
| ftp_permission | Boolean | Specifies whether the user is allowed to use the FTP protocol to connect to Files.com. This includes the use of FTPS (Implicit) and FTPS (Explicit) variations of FTP. |
| group_ids | String | Comma-delimited list of Group IDs of which this user is a member. |
| header_text | String | Test that is displayed to the user at the top of the Files.com web portal interface. |
| id | Int64 | The unique ID of the user account. |
| language | String | The language of the user. |
| last_active_at | Date-Time | The most recent activity date/time of the user. |
| last_api_use_at | Date-Time | The most recent usage date/time of the user when using the Files.com REST APIs. |
| last_dav_login_at | Date-Time | The most recent WebDAV based login date/time of the user. |
| last_desktop_login_at | Date-Time | The most recent login date/time of the user from the Files.com Desktop App. |
| last_ftp_login_at | Date-Time | The most recent FTP based login date/time of the user. This includes the use of FTPS (Implicit) and FTPS (Explicit). |
| last_login_at | Date-Time | The most recent login date/time of the user. |
| last_protocol_cipher | String | The most recent connection protocol and cipher used by the user. |
| last_restapi_login_at | Date-Time | The most recent login date/time of the user when using the Files.com REST APIs. |
| last_sftp_login_at | Date-Time | The most recent SFTP based login date/time of the user. |
| last_web_login_at | Date-Time | The most recent web portal login date/time of the user. |
| lockout_expires | Date-Time | The expiration date/time of the lock, if any, that prevents the user from logging in to your Files.com site. |
| name | String | The full name of the user. |
| notes | String | Internal notes about the user. |
| notification_daily_send_time | Int64 | Hour of the day at which daily notifications are sent to the user. In the range of 0 to 23. |
| office_integration_enabled | Boolean | Specifies whether integration with Microsoft 365 is enabled for the user. |
| password_expire_at | Date-Time | The date/time that the password expires for the user. |
| password_expired | Boolean | Specifies whether the user’s password has expired. |
| password_set_at | Date-Time | The date/time of the last time that the user’s password was set. |
| password_validity_days | Int64 | Number of days that a password can be used for. |
| public_keys_count | Int64 | Number of SFTP Keys associated with the user. |
| receive_admin_alerts | Boolean | Whether the user should receive administrator alerts, such as certificate expiration and overage notifications. |
| require_2fa | String | Specifies whether 2FA is required for this user to login. Possible values are: use_system_setting, always_require, never_require |
| require_login_by | Date-Time | Specifies the date/time that the user must login by in order to avoid their account being disabled. |
| require_password_change | Boolean | Specifies whether a password change is required by the user upon next login attempt. |
| restapi_permission | Boolean | Specifies whether the user is allowed to use the Files.com web portal, or the Files.com REST APIs, to connect to Files.com. |
| self_managed | Boolean | Specifies whether the user account can manage its own credentials. |
| sftp_permission | Boolean | Specifies whether the user is allowed to use the SFTP protocol to connect to Files.com. |
| site_admin | Boolean | Specifies whether the user has site administrator privileges for your Files.com site. |
| skip_welcome_screen | Boolean | Specifies whether the Files.com welcome screen should be skipped when the user logs in. |
| ssl_required | String | Specifies whether TLS/SSL encryption is required for connections made by this user. Possible values are: use_system_setting, always_require, never_require |
| sso_strategy_id | Int64 | Specifies the ID of the SSO configuration for the user. |
| subscribe_to_newsletter | Boolean | Specifies whether the user is subscribed to the Files.com newsletter. |
| time_zone | String | The time zone of the user. |
| type_of_2fa | String | Specifies the types of 2FA methods in use for the user. Will be either sms, totp, u2f, yubi, or multiple values sorted alphabetically and joined by an underscore. |
| user_root | String | Root folder for FTP, and optionally SFTP if the corresponding site-wide setting is set, for the user. This is not used for API, Desktop, or Web interface. |
| username | String | The login username of the user. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
Delete
This operation will delete an item in your Files.com site. Details about the deleted item will be included in the response.
When creating a new Files.com Connector Operation, select a Connection component, select the Connector Action for Delete, and select a Connector Operation component.
When creating a new Connector Operation component, select the Import Operation button, use the Import Wizard to complete the import. Select the Object Type of the item that you wish to delete:
- File
- Folder
- Group
- ShareLink
- ShareLinkNotification
- User
A Request Profile will be created for you. The “Delete” action does not create a Response Profile.
File
This operation will delete a file in your Files.com site. The response for this action will always be empty. After the operation import, the following Parameters will be available for the connector step:
- id - (Required) The path to the file to be deleted. This should be the full absolute path. Include the file name and file extension.
Folder
This operation will delete a folder in your Files.com site. The folder must be empty for the deletion to succeed. The response for this action will always be empty.
After the operation import, the following Parameters will be available for the connector step:
- id - (Required) The path to the folder to be deleted. This should be the full absolute path.
Group
This operation will delete a group in your Files.com site. The response for this action will always be empty. After the operation import, the following Parameters will be available for the connector step:
- id - (Required) The ID of the group to be deleted.
ShareLink
This operation will delete a Share Link in your Files.com site. Deleting a share link will also delete its associated registration and download information. If you need to preserve this information, such as for audit purposes, we strongly recommend using the Update operation to expire the share link instead. The response for this action will always be empty. After the operation import, the following Parameters will be available for the connector step:
- id - (Required) The ID of the share link to be deleted.
ShareLinkNotification
This operation will remove a Notification from a Share Link in your Files.com site. The response for this action will always be empty.
After the operation import, the following Parameters will be available for the connector step:
- id - (Required) The ID of the share link notification to be deleted.
User
This operation will delete a User account in your Files.com site. Deleting a user account will also delete its associated information. If you need to preserve this information, such as for audit purposes, we strongly recommend using the Update operation to disable the user account instead. The response for this action will always be empty.
After the operation import, the following Parameters will be available for the connector step:
- id - (Required) The ID of the user to be deleted.
Download
This operation will return (download) the contents of a file in your Files.com site. This applies to any file on Files.com, including Remote Mount files stored on supported platforms such as Microsoft (Azure Blob, Azure Files, SharePoint, OneDrive), Amazon S3, Google (Cloud and Drive), BackBlaze B2, Rackspace Cloud Files Storage, Wasabi Hot Cloud Storage, any remote FTP site, any remote SFTP site, Box, and Dropbox.
When creating a new Files.com Connector Operation, select a Connection component, select the Connector Action for Download, and select a Connector Operation component.
When creating a new Connector Operation component, select the Import Operation button, and use the Import Wizard to complete the import. A Request Profile will be created for you. The Download action does not create a Response Profile.
After the operation import, the following Parameters will be available for the connector step:
- ID - (Required) The path to the file. This should be the full absolute folder path including the file name and file extension. The result of the file download, containing the contents of the file, will be passed on as data to your subsequent Boomi process steps.
List
This operation will list items in your Files.com site. Each item in the list will be returned in its own response. When creating a new Files.com Connector Operation, select a Connection component, select the Connector Action for List, and select a Connector Operation component.
When creating a new Connector Operation component, select the Import Operation button, use the Import Wizard to complete the import. Select the Object Type of the item that you wish to list:
- Folder
- Groups
- ShareLinks
- ShareLinkDownloads
- ShareLinkNotifications
- ShareLinkRecipients
- ShareLinkRegistrations
- Users
The Limit option of the operation can be used to limit the returned results to the number of items specified.
A Request Profile will be created for you.
Folder
This operation will return a list of items contained within a folder of your Files.com site. Each item in the list will be returned in its own response. This connector operation requires an ID parameter. In the Parameters tab, use the import link to import the ID parameter if it doesn’t already exist for the connector step.
- ID – (Required) The path of the folder to be listed. This should be the full absolute path.
Each item in the results will be passed on as a separate document to your Boomi process. The Response Profile for each item, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| crc32 | String | If available, the CRC32 checksum of the file. |
| created_at | Date-Time | The creation date/time of the file or folder. |
| display_name | String | The name of the file or folder, as displayed to the user. |
| download_uri | String | Link to download the file. |
| is_locked | Boolean | Specifies whether a folder is locked and cannot be modified. |
| md5 | String | If available, the MD5 checksum of the file. |
| mime_type | String | The MIME type of the file. |
| mtime | Date-Time | The last modification date/time of the item on Files.com. |
| path | String | The path of the file or folder. |
| permissions | String | A short string representing the connector's permissions. Can be r (Read), w (Write), d (Delete), l (List) or any combination. |
| provided_mtime | Date-Time | If available, the last modification date/time of the item provided to Files.com from the previously hosting system. |
| region | String | The Files.com storage region that the item is stored in. |
| size | Int64 | The size in bytes of the file. |
| subfolders_locked | Boolean | Specifies whether subfolders are locked and cannot be modified. |
| type | String | The type of the item, either directory or file. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
Groups
This operation will list all groups that exist in your Files.com site. Each item in the list will be returned in its own response. This connector operation requires an ID parameter. In the Parameters tab, use the import link to import the ID parameter if it doesn’t already exist for the connector step. The value of the ID parameter, which is required by Boomi, is not used by thisoperation and can be set to any arbitrary value or left blank. Each group item in the results will be passed on as a separate document to your Boomi process. The response for each group item, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| admin_ids | String | A comma-delimited list of User IDs. These users have administration privileges for this group. |
| dav_permission | Boolean | Specifies if members of this group are allowed to use the WebDAV protocol to connect to Files.com. |
| ftp_permission | Boolean | Specifies if members of this group are allowed to use the FTP protocol to connect to Files.com. This includes the use of FTPS (Implicit) and FTPS (Explicit) variations of FTP. |
| id | Int64 | The unique ID of the group. |
| name | String | The name of the group. |
| notes | String | Internal notes about the group. |
| restapi_permission | Boolean | Specifies if members of this group are allowed to use the Files.com web portal, or the Files.com REST APIs, to connect to Files.com. |
| sftp_permission | Boolean | Specifies if members of this group are allowed to use the SFTP protocol to connect to Files.com. |
| user_ids | String | A comma-delimited list of User IDs. These users are members of this group. |
| usernames | String | A comma-delimited list of user names, corresponding with the User IDs above. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
ShareLinks
This operation will list all Share Links that exist in your Files.com site. Each item in the list will be returned in its own response. This connector operation requires an ID parameter. In the Parameters tab, use the import link to import the ID parameter if it doesn’t already exist for the connector step. The value of the ID parameter, which is required by Boomi, is not used by this operation and can be set to any arbitrary value or left blank. Each Share Link item in the results will be passed on as a separate document to your Boomi process. The response for each Share Link item, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| clickwrap_body | String | Specifies the terms that will be presented to the share link visitors prior to accessing the contents. Visitors must agree to the terms in order to be allowed access. |
| clickwrap_id | Int64 | The ID of the clickwrap being used with this share link. |
| code | String | The share link code. This is used as the suffix of the link URL. |
| created_at | Date-Time | Specifies the creation date/time of the share link. |
| description | String | Public description of the share link. |
| dont_separate_submissions_by_folder | Boolean | Prevents submissions to the share link from being separated into sub-folders. Not recommended as duplicate submissions can cause overwriting of files. |
| expires_at | Date-Time | The date/time of when access to the share link expires. |
| form_field_set | FormFieldSet | Specifies the custom registration form to be used with the share link. |
| form_field_set_id | Int64 | The ID of the Form Field Set used by the share link. |
| has_inbox | Boolean | Specifies whether the share link has an associated inbox. |
| id | Int64 | The unique ID of the share link. |
| inbox_id | Int64 | The ID of the associated inbox. |
| max_uses | Int64 | The maximum number of times that the share link can be used. |
| note | String | Internal note for the share link. |
| password_protected | Boolean | Specifies whether the share link is password protected. |
| path_template | String | Template for creating submission subfolders for the share link. Can use the visitor's name, email address, IP address, company name, and other custom form data. |
| permissions | String | Specifies the access permissions for folders contained in the share link. Possible values: read, write, read_write, full, none, preview_only |
| require_registration | Boolean | Specifies whether the share link should present a registration page to capture visitor information. |
| require_share_recipient | Boolean | Specifies whether the share link can only be used by recipients who have explicitly received the link via an email sent from Files.com. |
| require_logout | Boolean | Specifies whether the share link registration page should remove the “Remember Me” option so that each visit is considered a new login session by visitors. |
| send_email_receipt_to_uploader | Boolean | Specifies whether to send a delivery receipt email to the uploader. Only applies to share links that have write permission. |
| skip_company | Boolean | Specifies whether the default registration form should omit asking for a visitor company name. |
| skip_email | Boolean | Specifies whether the default registration form should omit asking for a visitor email. |
| skip_name | Boolean | Specifies whether the default registration form should omit asking for a visitor name. |
| start_access_on_date | Date-Time | Specifies the start date/time that the share link will be accessible. |
| url | String | Public URL of the share link. |
| user_id | Int64 | The User ID of the user that created the share link. |
| username | String | The username of the user account that created the share link. |
| watermark_attachment | Object | Specifies the watermark image to be used when previewing image files contained in the share link. |
| watermark_value | Object | Specifies the watermark value to be used when previewing image files contained in the share link. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
ShareLinkDownloads
This operation will list all downloads made for a specific share link in your Files.com site. Each download item in the list will be returned in its own response. This connector operation requires an ID parameter. In the Parameters tab, use the import link to import the ID parameter if it doesn’t already exist for the connector step.
- ID – (Required) The ID (bundle_id) of the share link.
Each Share Link Download item in the results will be passed on as a separate document to your Boomi process. The response for each Share Link Download item, represented as a JSON dictionary, may include the following output keysnand values:
| Key | Value Format | Description |
|---|---|---|
| bundle_registration | Array | If available, the captured registration information. |
| created_at | Date-Time | Specifies the date/time of the download event. |
| download_method | String | Download method that was used. Either an individual file, or a zip containing all files, was downloaded. Possible values: file, full_zip |
| path | String | The path of the downloaded item. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
ShareLinkNotifications
This operation will list all Share Link Notifications that exist in your Files.com site. Each item in the list will be returned in its own response. This connector operation requires an ID parameter. In the Parameters tab, use the import link to import the ID parameter if it doesn’t already exist for the connector step. The value of the ID parameter, which is required by Boomi, is not used by this operation and can be set to any arbitrary value or left blank. Each Share Link Notification item in the results will be passed on as a separate document to your Boomi process. The response for each Share Link Notification item, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| bundle_id | Int64 | The ID of the share link that this notification is associated with. |
| id | Int64 | The ID of the share link notification. |
| notify_on_registration | Boolean | Specifies whether the notification is triggered by a registration occurring. |
| notify_on_upload | Boolean | Specifies whether the notification is triggered when an upload to the share link occurs. |
| user_id | Int64 | The User ID of the user that will receive the notification. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
ShareLinkRecipients
This operation will list any recipients of a specific share link in your Files.com site. Each recipient item in the list will be returned in its own response.
This connector operation requires an ID parameter. In the Parameters tab, use the import link to import the ID parameter if it doesn’t already exist for the connector step.
- ID – (Required) The ID (bundle_id) of the share link.
Each Share Link Recipient item in the results will be passed on as a separate document to your Boomi process. The response for each Share Link Recipient item, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| company | String | The company name for the recipient. |
| name | String | The full name of the recipient. |
| note | String | Note sent to the recipient. |
| recipient | String | The email address of the recipient. |
| sent_at | Date-Time | Specifies the date/time of when the email to the recipient was sent. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
ShareLinkRegistrations
This operation will list any Registrations of a specific share link in your Files.com site. Each registration item in the list will be returned in its own response. This connector operation requires an ID parameter. In the Parameters tab, use the import link to import the ID parameter if it doesn’t already exist for the connector step.
- ID – (Required) The ID (bundle_id) of the share link.
Each Share Link Registration item in the results will be passed on as a separate document to your Boomi process. The response for each Share Link Registration item, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| bundle_code | String | The share link code. Used as the suffix of the link URL. |
| bundle_id | Int64 | The ID of the share link. |
| bundle_recipient_id | Int64 | The ID of the recipient. |
| clickwrap_body | String | Specifies the terms that will be presented to the share link visitors prior to accessing the contents. Visitors must agree to the terms in order to be allowed access. |
| code | String | Registration cookie code. |
| company | String | The provided company name. |
| created_at | Date-Time | The creation date/time of the registration. |
| String | The provided email address. | |
| form_field_data | Array | The keys and provided values of the form fields. |
| form_field_set_id | Int64 | The ID of the custom registration form associated with this share link. |
| inbox_code | String | Inbox registration cookie code if there is an associated inbox registration. |
| ip | String | Registration IP Address. |
| name | String | The provided full name in the registration. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
Users
This operation will list all users that exist in your Files.com site. Each user item in the list will be returned in its own response.
This connector operation requires an ID parameter. In the Parameters tab, use the import link to import the ID parameter if it doesn’t already exist for the connector step. The value of the ID parameter, which is required by Boomi, is not used by this operation and can be set to any arbitrary value or left blank. Each user item in the results will be passed on as a separate document to your Boomi process. The response for each user item, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| active_2fa | Boolean | Specifies whether 2FA is enabled for the user. |
| admin_group_ids | String | A comma-delimited list of Group IDs of which the user has administration privileges for. |
| allowed_ips | String | A list of allowed IP addresses that this user can connect to your Files.com site from. |
| api_keys_count | Int64 | Number of API keys associated with this user. |
| authenticate_until | Date-Time | Scheduled date/time at which user will be deactivated. |
| authentication_method | String | The method that is used to authenticate the user. |
| avatar_url | String | URL to the user’s avatar image file. |
| billing_permission | Boolean | Specifies whether the user can access payment, invoice, and billing areas of your Files.com site. |
| bypass_inactive_disable | Boolean | Specifies whether the user is exempt from being disabled due to inactivity. |
| bypass_site_allowed_ips | Boolean | Specifies whether the user can bypass the list of denied IP addresses of your Files.com site. |
| company | String | The company name for the user. |
| created_at | Date-Time | Creation date/time of the user account. |
| dav_permission | Boolean | Specifies whether the user is allowed to use the WebDAV protocol to connect to Files.com. |
| days_remaining_until_password_expire | Int64 | Number of days remaining until the password expires for the user. |
| disabled | Boolean | Specifies whether the user account is disabled. |
| The email address of the user. | ||
| externally_managed | Boolean | Specifies whether the user account is managed by a SSO system integrated with your Files.com site. |
| first_login_at | Date-Time | The date/time of the first login by the user. |
| ftp_permission | Boolean | Specifies whether the user is allowed to use the FTP protocol to connect to Files.com. This includes the use of FTPS (Implicit) and FTPS (Explicit) variations of FTP. |
| group_ids | String | Comma-delimited list of Group IDs of which this user is a member. |
| header_text | String | Test that is displayed to the user at the top of the Files.com web portal interface. |
| id | Int64 | The unique ID of the user account. |
| language | String | The language of the user. |
| last_active_at | Date-Time | The most recent activity date/time of the user. |
| last_api_use_at | Date-Time | The most recent usage date/time of the user when using the Files.com REST APIs. |
| last_dav_login_at | Date-Time | The most recent WebDAV based login date/time of the user. |
| last_desktop_login_at | Date-Time | The most recent login date/time of the user from the Files.com Desktop App. |
| last_ftp_login_at | Date-Time | The most recent FTP based login date/time of the user. This includes the use of FTPS (Implicit) and FTPS (Explicit). |
| last_login_at | Date-Time | The most recent login date/time of the user. |
| last_protocol_cipher | String | The most recent connection protocol and cipher used by the user. |
| last_restapi_login_at | Date-Time | The most recent login date/time of the user when using the Files.com REST APIs. |
| last_sftp_login_at | Date-Time | The most recent SFTP based login date/time of the user. |
| last_web_login_at | Date-Time | The most recent web portal login date/time of the user. |
| lockout_expires | Date-Time | The expiration date/time of the lock, if any, that prevents the user from logging in to your Files.com site. |
| name | String | The full name of the user. |
| notes | String | Internal notes about the user. |
| notification_daily_send_time | Int64 | Hour of the day at which daily notifications are sent to the user. In the range of 0 to 23. |
| office_integration_enabled | Boolean | Specifies whether integration with Microsoft 365 is enabled for the user. |
| password_expire_at | Date-Time | The date/time that the password expires for the user. |
| password_expired | Boolean | Specifies whether the user’s password has expired. |
| password_set_at | Date-Time | The date/time of the last time that the user’s password was set. |
| password_validity_days | Int64 | Number of days that a password can be used for. |
| public_keys_count | Int64 | Number of SFTP Keys associated with the user. |
| receive_admin_alerts | Boolean | Whether the user should receive administrator alerts, such as certificate expiration and overage notifications. |
| require_2fa | String | Specifies whether 2FA is required for this user to login. Possible values are: use_system_setting, always_require, never_require |
| require_login_by | Date-Time | Specifies the date/time that the user must login by in order to avoid their account being disabled. |
| require_password_change | Boolean | Specifies whether a password change is required by the user upon next login attempt. |
| restapi_permission | Boolean | Specifies whether the user is allowed to use the Files.com web portal, or the Files.com REST APIs, to connect to Files.com. |
| self_managed | Boolean | Specifies whether the user account can manage its own credentials. |
| sftp_permission | Boolean | Specifies whether the user is allowed to use the SFTP protocol to connect to Files.com. |
| site_admin | Boolean | Specifies whether the user has site administrator privileges for your Files.com site. |
| skip_welcome_screen | Boolean | Specifies whether the Files.com welcome screen should be skipped when the user logs in. |
| ssl_required | String | Specifies whether TLS/SSL encryption is required for connections made by this user. Possible values are: use_system_setting, always_require, never_require |
| sso_strategy_id | Int64 | Specifies the ID of the SSO configuration for the user. |
| subscribe_to_newsletter | Boolean | Specifies whether the user is subscribed to the Files.com newsletter. |
| time_zone | String | The time zone of the user. |
| type_of_2fa | String | Specifies the types of 2FA methods in use for the user. Will be either sms, totp, u2f, yubi, or multiple values sorted alphabetically and joined by an underscore. |
| user_root | String | Root folder for FTP, and optionally SFTP if the corresponding site-wide setting is set, for the user. This is not used for API, Desktop, or Web interface. |
| username | String | The login username of the user. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
Move
This operation will move or rename a file or folder in your Files.com site. This is an asynchronous operation which is performed as a background process. The status of this background process should be checked, to confirm that the process has been completed, prior to attempting any actions on the result of the move. When creating a new Files.com Connector Operation, select a Connection component, select the Connector Action for Move, and select a Connector Operation component. When creating a new Connector Operation component, select the Import Operation button, and use the Import Wizard to complete the import. A Request Profile will be created for you. The Move action does not create a Response Profile. After the operation import, the following Parameters will be available for the connector step:
- destination – (Required) The destination path to be moved to. This should be the full absolute path. Include the file name and file extension when specifying a file.
- path – (Required) The path to the file or folder to be moved. This should be the full absolute path to the file or folder.
The response to this action, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| file_migration_id | String | The ID of the background File Migration operation. |
| status | String | The status of the File Migration operation. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
Show
This operation will retrieve the details of a specific item in your Files.com site. When creating a new Files.com Connector Operation, select a Connection component, select the Connector Action for Show, and select a Connector Operation component. When creating a new Connector Operation component, select the Import Operation button, use the Import Wizard to complete the import. Select the Object Type of the item that you wish to view details of:
- FileDetails
- FolderDetails
- GroupDetails
- ShareLinkDetails
- ShareLinkNotificationDetails
- UserDetails
A Request Profile will be created for you.
FileDetails
This operation will return the details of a file in your Files.com site. This includes any file within Remote Mount folders from supported platforms such as Microsoft (Azure Blob, Azure Files, SharePoint, OneDrive), Amazon S3, Google (Cloud and Drive), BackBlaze B2, Rackspace Cloud Files Storage, Wasabi Hot Cloud Storage, any remote FTP site, any remote SFTP site, Box, and Dropbox. This connector operation requires an ID parameter. In the Parameters tab, use the import link to import the ID parameter if it doesn’t already exist for the connector step.
- ID – (Required) The path of the file. This should be the full absolute path, including the file name and file extension. The Response Profile, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| crc32 | String | If available, the CRC32 checksum of the file. |
| created_at | Date-Time | The creation date/time of the file or folder. |
| display_name | String | The name of the file or folder, as displayed to the user. |
| download_uri | String | Link to download the file. |
| is_locked | Boolean | Specifies whether a folder is locked and cannot be modified. |
| length | Int64 | The length in bytes of the file. |
| md5 | String | If available, the MD5 checksum of the file. |
| mime_type | String | The MIME type of the file. |
| mtime | Date-Time | The last modification date/time of the item on Files.com. |
| path | String | The path of the file or folder. Must be slash-delimited and neither start nor end with a slash. Maximum length of 5000 characters. |
| permissions | String | A short string representing the connector's permissions. Can be r (Read), w (Write), d (Delete), l (List) or any combination. |
| provided_mtime | Date-Time | If available, the last modification date/time of the item provided to Files.com from the previously hosting system. |
| region | String | The Files.com storage region that the item is stored in. |
| size | Int64 | The size in bytes of the file. |
| subfolders_locked | Boolean | Specifies whether subfolders are locked and cannot be modified. |
| type | String | The type of the item, either directory or file. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
FolderDetails
This operation will return the details of a folder in your Files.com site. This includes any folder within Remote Mount folders from supported platforms such as Microsoft (Azure Blob, Azure Files, SharePoint, OneDrive), Amazon S3, Google (Cloud and Drive), BackBlaze B2, Rackspace Cloud Files Storage, Wasabi Hot Cloud Storage, any remote FTP site, any remote SFTP site, Box, and Dropbox.
This connector operation requires an ID parameter. In the Parameters tab, use the import link to import the ID parameter if it doesn’t already exist for the connector step.
- ID – (Required) The path of the folder. This should be the full absolute path.
The Response Profile, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| crc32 | String | If available, the CRC32 checksum of the file. |
| created_at | Date-Time | The creation date/time of the file or folder. |
| display_name | String | The name of the file or folder, as displayed to the user. |
| download_uri | String | Link to download the file. |
| is_locked | Boolean | Specifies whether a folder is locked and cannot be modified. |
| length | Int64 | The length in bytes of the file. |
| md5 | String | If available, the MD5 checksum of the file. |
| mime_type | String | The MIME type of the file. |
| mtime | Date-Time | The last modification date/time of the item on Files.com. |
| path | String | The path of the file or folder. Must be slash-delimited and neither start nor end with a slash. Maximum length of 5000 characters. |
| permissions | String | A short string representing the connector's permissions. Can be r (Read), w (Write), d (Delete), l (List) or any combination. |
| provided_mtime | Date-Time | If available, the last modification date/time of the item provided to Files.com from the previously hosting system. |
| region | String | The Files.com storage region that the item is stored in. |
| size | Int64 | The size in bytes of the file. |
| subfolders_locked | Boolean | Specifies whether subfolders are locked and cannot be modified. |
| type | String | The type of the item, either directory or file. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
GroupDetails
This operation will return the details of a group in your Files.com site. This connector operation requires an ID parameter. In the Parameters tab, use the import link to import the ID parameter if it doesn’t already exist for the connector step.
- ID – (Required) The ID (group_id) of the Group.
The Response Profile, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| admin_ids | String | A comma-delimited list of User IDs. These users have administration privileges for this group. |
| dav_permission | Boolean | Specifies if members of this group are allowed to use the WebDAV protocol to connect to Files.com. |
| ftp_permission | Boolean | Specifies if members of this group are allowed to use the FTP protocol to connect to Files.com. This includes the use of FTPS (Implicit) and FTPS (Explicit) variations of FTP. |
| id | Int64 | The unique ID of the group. |
| name | String | The name of the group. |
| notes | String | Internal notes about the group. |
| restapi_permission | Boolean | Specifies if members of this group are allowed to use the Files.com web portal, or the Files.com REST APIs, to connect to Files.com. |
| sftp_permission | Boolean | Specifies if members of this group are allowed to use the SFTP protocol to connect to Files.com. |
| user_ids | String | A comma-delimited list of User IDs. These users are members of this group. |
| usernames | String | A comma-delimited list of user names, corresponding with the User IDs above. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
ShareLinkDetails
This operation will return the details of a Share Link in your Files.com site. This connector operation requires an ID parameter. In the Parameters tab, use the import link to import the ID parameter if it doesn’t already exist for the connector step.
- ID – (Required) The ID of the Share Link.
The Response Profile, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| code | String | The share link code. This is used as the suffix of the link URL. |
| created_at | Date-Time | Specifies the creation date/time of the share link. |
| description | String | Public description of the share link. |
| dont_separate_submissions_by_folder | Boolean | Prevents submissions to the share link from being separated into sub-folders. Not recommended as duplicate submissions can cause overwriting of files. |
| expires_at | Date-Time | The date/time of when access to the share link expires. |
| has_inbox | Boolean | Specifies whether the share link has an associated inbox. |
| id | Int64 | The unique ID of the share link. |
| max_uses | Int64 | The maximum number of times that the share link can be used. |
| note | String | Internal note for the share link. |
| password_protected | Boolean | Specifies whether the share link is password protected. |
| paths | String | Comma separated list of paths to files and folders that will be accessible using the share link. |
| permissions | String | Specifies the access permissions for folders contained in the share link. Possible values: read, write, read_write, full, none, preview_only |
| require_logout | Boolean | Specifies whether the share link registration page should remove the “Remember Me” option so that each visit is considered a new login session by visitors. |
| require_registration | Boolean | Specifies whether the share link should present a registration page to capture visitor information. |
| require_share_recipient | Boolean | Specifies whether the share link can only be used by recipients who have explicitly received the link via an email sent from Files.com. |
| send_email_receipt_to_uploader | Boolean | Specifies whether to send a delivery receipt email to the uploader. Only applies to share links that have write permission. |
| skip_company | Boolean | Specifies whether the default registration form should omit asking for a visitor company name. |
| skip_email | Boolean | Specifies whether the default registration form should omit asking for a visitor email. |
| skip_name | Boolean | Specifies whether the default registration form should omit asking for a visitor name. |
| url | String | Public URL of the share link. |
| user_id | Int64 | The User ID of the user that created the share link. |
| username | String | The username of the user account that created the share link. |
The above values can be queried, and the results used in subsequent steps of your Boomi process. The returned url value is the link that should be provided to recipients for the Share Link.
ShareLinkNotificationDetails
This operation will return the details of a Share Link Notification in your Files.com site. This connector operation requires an ID parameter. In the Parameters tab, use the import link to import the ID parameter if it doesn’t already exist for the connector step.
- ID – (Required) The ID of the Share Link Notification.
The Response Profile, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| bundle_id | Int64 | The ID of the share link that this notification is associated with. |
| id | Int64 | The ID of the share link notification. |
| notify_on_registration | Boolean | Specifies whether the notification is triggered by a registration occurring. |
| notify_on_upload | Boolean | Specifies whether the notification is triggered when an upload to the share link occurs. |
| user_id | Int64 | The User ID of the user that will receive the notification. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
UserDetails
This operation will return the details of a user account in your Files.com site. This connector operation requires an ID parameter. In the Parameters tab, use the import link to import the ID parameter if it doesn’t already exist for the connector step.
- ID – (Required) The ID of the user account.
The Response Profile, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| active_2fa | Boolean | Specifies whether 2FA is enabled for the user. |
| admin_group_ids | String | A comma-delimited list of Group IDs of which the user has administration privileges for. |
| allowed_ips | String | A list of allowed IP addresses that this user can connect to your Files.com site from. |
| api_keys_count | Int64 | Number of API keys associated with this user. |
| authenticate_until | Date-Time | Scheduled date/time at which user will be deactivated. |
| authentication_method | String | The method that is used to authenticate the user. |
| avatar_url | String | URL to the user’s avatar image file. |
| billing_permission | Boolean | Specifies whether the user can access payment, invoice, and billing areas of your Files.com site. |
| bypass_inactive_disable | Boolean | Specifies whether the user is exempt from being disabled due to inactivity. |
| bypass_site_allowed_ips | Boolean | Specifies whether the user can bypass the list of denied IP addresses of your Files.com site. |
| company | String | The company name for the user. |
| created_at | Date-Time | Creation date/time of the user account. |
| dav_permission | Boolean | Specifies whether the user is allowed to use the WebDAV protocol to connect to Files.com. |
| days_remaining_until_password_expire | Int64 | Number of days remaining until the password expires for the user. |
| disabled | Boolean | Specifies whether the user account is disabled. |
| The email address of the user. | ||
| externally_managed | Boolean | Specifies whether the user account is managed by a SSO system integrated with your Files.com site. |
| first_login_at | Date-Time | The date/time of the first login by the user. |
| ftp_permission | Boolean | Specifies whether the user is allowed to use the FTP protocol to connect to Files.com. This includes the use of FTPS (Implicit) and FTPS (Explicit) variations of FTP. |
| group_ids | String | Comma-delimited list of Group IDs of which this user is a member. |
| header_text | String | Test that is displayed to the user at the top of the Files.com web portal interface. |
| id | Int64 | The unique ID of the user account. |
| language | String | The language of the user. |
| last_api_use_at | Date-Time | The most recent usage date/time of the user when using the Files.com REST APIs. |
| last_dav_login_at | Date-Time | The most recent WebDAV based login date/time of the user. |
| last_desktop_login_at | Date-Time | The most recent login date/time of the user from the Files.com Desktop App. |
| last_ftp_login_at | Date-Time | The most recent FTP based login date/time of the user. This includes the use of FTPS (Implicit) and FTPS (Explicit). |
| last_login_at | Date-Time | The most recent login date/time of the user. |
| last_protocol_cipher | String | The most recent connection protocol and cipher used by the user. |
| last_restapi_login_at | Date-Time | The most recent login date/time of the user when using the Files.com REST APIs. |
| last_sftp_login_at | Date-Time | The most recent SFTP based login date/time of the user. |
| last_web_login_at | Date-Time | The most recent web portal login date/time of the user. |
| lockout_expires | Date-Time | The expiration date/time of the lock, if any, that prevents the user from logging in to your Files.com site. |
| name | String | The full name of the user. |
| notes | String | Internal notes about the user. |
| notification_daily_send_time | Int64 | Hour of the day at which daily notifications are sent to the user. In the range of 0 to 23. |
| office_integration_enabled | Boolean | Specifies whether integration with Microsoft 365 is enabled for the user. |
| password_expire_at | Date-Time | The date/time that the password expires for the user. |
| password_expired | Boolean | Specifies whether the user’s password has expired. |
| password_set_at | Date-Time | The date/time of the last time that the user’s password was set. |
| password_validity_days | Int64 | Number of days that a password can be used for. |
| public_keys_count | Int64 | Number of SFTP Keys associated with the user. |
| receive_admin_alerts | Boolean | Whether the user should receive administrator alerts, such as certificate expiration and overage notifications. |
| require_2fa | String | Specifies whether 2FA is required for this user to login. Possible values are: use_system_setting, always_require, never_require |
| require_login_by | Date-Time | Specifies the date/time that the user must login by in order to avoid their |
| account being disabled. | ||
| require_password_change | Boolean | Specifies whether a password change is required by the user upon next login attempt. |
| restapi_permission | Boolean | Specifies whether the user is allowed to use the Files.com web portal, or the Files.com REST APIs, to connect to Files.com. |
| self_managed | Boolean | Specifies whether the user account can manage its own credentials. |
| sftp_permission | Boolean | Specifies whether the user is allowed to use the SFTP protocol to connect to Files.com. |
| site_admin | Boolean | Specifies whether the user has site administrator privileges for your Files.com site. |
| skip_welcome_screen | Boolean | Specifies whether the Files.com welcome screen should be skipped when the user logs in. |
| ssl_required | String | Specifies whether TLS/SSL encryption is required for connections made by this user. Possible values are: use_system_setting, always_require, never_require |
| sso_strategy_id | Int64 | Specifies the ID of the SSO configuration for the user. |
| subscribe_to_newsletter | Boolean | Specifies whether the user is subscribed to the Files.com newsletter. |
| time_zone | String | The time zone of the user. |
| type_of_2fa | String | Specifies the types of 2FA methods in use for the user. Will be either sms, totp, u2f, yubi, or multiple values sorted alphabetically and joined by an underscore. |
| user_root | String | Root folder for FTP, and optionally SFTP if the corresponding site-wide setting is set, for the user. This is not used for API, Desktop, or Web interface. |
| username | String | The login username of the user. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
Update
This operation will update an item in your Files.com site. Details about the updated item will be included in the response. When creating a new Files.com Connector Operation, select a Connection component, select the Connector Action for Update, and select a Connector Operation component. When creating a new Connector Operation component, select the Import Operation button, use the Import Wizard to complete the import. Select the Object Type of the item that you wish to update:
- Group
- ShareLink
- ShareLinkNotification
- User
A Request Profile will be created for you. The “Update” action does not create a Response Profile.
Group
This operation will update a group in your Files.com site. Details of the updated group are included in the response. After the operation import, the following Parameters will be available for the connec tor step:
- admin_ids – (Optional) A comma-delimited list of User IDs. These users will have administration privileges for this group.
- id – (Required) The ID of the group to be updated.
- name – (Optional) The updated name for the group.
- notes – (Optional) An updated internal note about the group. This note can be viewed by administrators of your Files.com site.
- user_ids – (Optional) A comma-delimited list of User IDs. These users will become members of the group.
The response to this action, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| admin_ids | String | A comma-delimited list of User IDs. These users have administration privileges for this group. |
| dav_permission | Boolean | Specifies if members of this group are allowed to use the WebDAV protocol to connect to Files.com. |
| ftp_permission | Boolean | Specifies if members of this group are allowed to use the FTP protocol to connect to Files.com. This includes the use of FTPS (Implicit) and FTPS (Explicit) variations of FTP. |
| id | Int64 | The unique ID of the group. |
| name | String | The name of the group. |
| notes | String | Internal notes about the group. |
| restapi_permission | Boolean | Specifies if members of this group are allowed to use the Files.com web portal, or the Files.com REST APIs, to connect to Files.com. |
| sftp_permission | Boolean | Specifies if members of this group are allowed to use the SFTP protocol to connect to Files.com. |
| user_ids | String | A comma-delimited list of User IDs. These users are members of this group. |
| usernames | String | A comma-delimited list of user names, corresponding with the User IDs above. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
ShareLink
This operation will update the expiration date of a share link in your Files.com site. A share link can be disabled by setting its expiration date to a past date. Details of the updated share link are included in the response. After the operation import, the following Parameters will be available for the connector step:
-
expires_at – (Required) The new expiration date and time for the share link. The link will not be available to visitors after this date and time. The date and time should be entered in Coordinated Universal Time (UTC) using
yyyyMMdd HHmmss.SSSformatting. For example:20240502 174500.000 -
id – (Required) The ID of the share link to be updated.
The response to this action, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| code | String | The share link code. This is used as the suffix of the link URL. |
| created_at | Date-Time | Specifies the creation date/time of the share link. |
| description | String | Public description of the share link. |
| dont_separate_submissions_by_folder | Boolean | Prevents submissions to the share link from being separated into sub-folders. Not recommended as duplicate submissions can cause overwriting of files. |
| expires_at | Date-Time | The date/time of when access to the share link expires. |
| has_inbox | Boolean | Specifies whether the share link has an associated inbox. |
| id | Int64 | The unique ID of the share link. |
| max_uses | Int64 | The maximum number of times that the share link can be used. |
| note | String | Internal note for the share link. |
| password_protected | Boolean | Specifies whether the share link is password protected. |
| paths | String | Comma separated list of paths to files and folders that will be accessible using the share link. |
| permissions | String | Specifies the access permissions for folders contained in the share link. Possible values: read, write, read_write, full, none, preview_only |
| require_logout | Boolean | Specifies whether the share link registration page should remove the “Remember Me” option so that each visit is considered a new login session by visitors. |
| require_registration | Boolean | Specifies whether the share link should present a registration page to capture visitor information. |
| require_share_recipient | Boolean | Specifies whether the share link can only be used by recipients who have explicitly received the link via an email sent from Files.com. |
| send_email_receipt_to_uploader | Boolean | Specifies whether to send a delivery receipt email to the uploader. Only applies to share links that have write permission. |
| skip_company | Boolean | Specifies whether the default registration form should omit asking for a visitor company name. |
| skip_email | Boolean | Specifies whether the default registration form should omit asking for a visitor email. |
| skip_name | Boolean | Specifies whether the default registration form should omit asking for a visitor name. |
| url | String | Public URL of the share link. |
| user_id | Int64 | The User ID of the user that created the share link. |
| username | String | The username of the user account that created the share link. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
ShareLinkNotification
This operation will update a Share Link Notification in your Files.com site. Details of the updated notification are included in the response. After the operation import, the following Parameters will be available for the connector step:
- id – (Required) The ID of the Share Link Notification to be updated.
- notify_on_registration – (Optional) Specifies whether the notification is triggered by a registration occurring. Provide a value of true or false.
- notify_on_upload - (Optional) Specifies whether the notification is triggered when an upload to the share link occurs. Provide a value of true or false.
The response to this action, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| bundle_id | Int64 | The ID of the share link that this notification is associated with. |
| id | Int64 | The ID of the share link notification. |
| notify_on_registration | Boolean | Specifies whether the share link notification is triggered by a registration occurring. |
| notify_on_upload | Boolean | Specifies whether the share link notification is triggered when an upload to the share link occurs. |
| user_id | Int64 | The User ID of the user that will receive the notification. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
User
This operation will update a user account in your Files.com site. Details of the updated user account are included in the response. After the operation import, the following Parameters will be available for the connector step:
- authentication_method - (Optional) Specifies the method that is used to authenticate the user. Select between assigning a password or sending an email to the user to allow them to set up their own password. When setting this option using a Dynamic Operation Property, provide a value of password or email_signup.
- company - (Optional) The company name of the user.
- email - (Optional) The email address of the user.
- group_ids - (Optional) A comma-delimited list of Group IDs that this user will become a member of.
- id - (Required) The ID of the user account.
- name - (Optional) The full name of the user.
- notes - (Optional) An internal note about the user account. This note can be viewed by administrators of your Files.com site.
- password - (Optional) The password for the user account.
- require_password_change - (Optional) Specifies whether the user must change their password on their next login. When setting this option using a Dynamic Operation Property provide a value of true or false.
- user_root - (Optional) Root folder for FTP, and optionally SFTP if the corresponding site-wide setting is set, for the user account. This is not used for API, Desktop, or Web interface based access.
- username - (Optional) The login username for the user.
The response to this action, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| active_2fa | Boolean | Specifies whether 2FA is enabled for the user. |
| admin_group_ids | String | A comma-delimited list of Group IDs of which the user has administration privileges for. |
| allowed_ips | String | A list of allowed IP addresses that this user can connect to your Files.com site from. |
| api_keys_count | Int64 | Number of API keys associated with this user. |
| authenticate_until | Date-Time | Scheduled date/time at which user will be deactivated. |
| authentication_method | String | The method that is used to authenticate the user. |
| avatar_url | String | URL to the user’s avatar image file. |
| billing_permission | Boolean | Specifies whether the user can access payment, invoice, and billing areas of your Files.com site. |
| bypass_site_allowed_ips | Boolean | Specifies whether the user can bypass the list of denied IP addresses of your Files.com site. |
| bypass_inactive_disable | Boolean | Specifies whether the user is exempt from being disabled due to inactivity. |
| company | String | The company name for the user. |
| created_at | Date-Time | Creation date/time of the user account. |
| dav_permission | Boolean | Specifies whether the user is allowed to use the WebDAV protocol to connect to Files.com. |
| days_remaining_until_password_expire | Int64 | Number of days remaining until the password expires for the user. |
| disabled | Boolean | Specifies whether the user account is disabled. |
| The email address of the user. | ||
| externally_managed | Boolean | Specifies whether the user account is managed by a SSO system integrated with your Files.com site. |
| first_login_at | Date-Time | The date/time of the first login by the user. |
| ftp_permission | Boolean | Specifies whether the user is allowed to use the FTP protocol to connect to Files.com. This includes the use of FTPS (Implicit) and FTPS (Explicit) variations of FTP. |
| group_ids | String | Comma-delimited list of Group IDs of which this user is a member. |
| header_text | String | Test that is displayed to the user at the top of the Files.com web portal interface. |
| id | Int64 | The unique ID of the user account. |
| language | String | The language of the user. |
| last_active_at | Date-Time | The most recent activity date/time of the user. |
| last_api_use_at | Date-Time | The most recent usage date/time of the user when using the Files.com REST APIs. |
| last_dav_login_at | Date-Time | The most recent WebDAV based login date/time of the user.v |
| last_desktop_login_at | Date-Time | The most recent login date/time of the user from the Files.com Desktop App. |
| last_ftp_login_at | Date-Time | The most recent FTP based login date/time of the user. This includes the use of FTPS (Implicit) and FTPS (Explicit). |
| last_login_at | Date-Time | The most recent login date/time of the user. |
| last_protocol_cipher | String | The most recent connection protocol and cipher used by the user. |
| last_restapi_login_at | Date-Time | The most recent login date/time of the user when using the Files.com REST APIs. |
| last_sftp_login_at | Date-Time | The most recent SFTP based login date/time of the user. |
| last_web_login_at | Date-Time | The most recent web portal login date/time of the user. |
| lockout_expires | Date-Time | The expiration date/time of the lock, if any, that prevents the user from logging in to your Files.com site. |
| name | String | The full name of the user. |
| notes | String | Internal notes about the user. |
| notification_daily_send_time | Int64 | Hour of the day at which daily notifications are sent to the user. In the range of 0 to 23. |
| office_integration_enabled | Boolean | Specifies whether integration with Microsoft 365 is enabled for the user. |
| password_expire_at | Date-Time | The date/time that the password expires for the user. |
| password_expired | Boolean | Specifies whether the user’s password has expired. |
| password_set_at | Date-Time | The date/time of the last time that the user’s password was set. |
| password_validity_days | Int64 | Number of days that a password can be used for. |
| public_keys_count | Int64 | Number of SFTP Keys associated with the user. |
| receive_admin_alerts | Boolean | Whether the user should receive administrator alerts, such as certificate expiration and overage notifications. |
| require_2fa | String | Specifies whether 2FA is required for this user to login. Possible values are: use_system_setting, always_require, never_require |
| require_login_by | Date-Time | Specifies the date/time that the user must login by in order to avoid their account being disabled. |
| require_password_change | Boolean | Specifies whether a password change is required by the user upon next login attempt. |
| restapi_permission | Boolean | Specifies whether the user is allowed to use the Files.com web portal, or the Files.com REST APIs, to connect to Files.com. |
| self_managed | Boolean | Specifies whether the user account can manage its own credentials. |
| sftp_permission | Boolean | Specifies whether the user is allowed to use the SFTP protocol to connect to Files.com. |
| site_admin | Boolean | Specifies whether the user has site administrator privileges for your Files.com site. |
| skip_welcome_screen | Boolean | Specifies whether the Files.com welcome screen should be skipped when the user logs in. |
| ssl_required | String | Specifies whether TLS/SSL encryption is required for connections made by this user. Possible values are: use_system_setting, always_require, never_require |
| sso_strategy_id | Int64 | Specifies the ID of the SSO configuration for the user. |
| subscribe_to_newsletter | Boolean | Specifies whether the user is subscribed to the Files.com newsletter. |
| time_zone | String | The time zone of the user. |
| type_of_2fa | String | Specifies the types of 2FA methods in use for the user. Will be either sms, totp, u2f, yubi, or multiple values sorted alphabetically and joined by an underscore. |
| user_root | String | Root folder for FTP, and optionally SFTP if the corresponding site-wide setting is set, for the user. This is not used for API, Desktop, or Web interface. |
| username | String | The login username of the user. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
Upload
This operation will upload the step’s input and save it to a specific folder and file name in your Files.com site. You can upload to any folder in your Files.com site including Remote Mount folders stored on supported platforms such as Microsoft (Azure Blob, Azure Files, SharePoint, OneDrive), Amazon S3, Google (Cloud and Drive), BackBlaze B2, Rackspace Cloud Files Storage, Wasabi Hot Cloud Storage, any remote FTP site, any remote SFTP site, Box, and Dropbox. Details about the uploaded file are included in the response. When creating a new Files.com Connector Operation, select a Connection component, select the Connector Action for Upload, and select a Connector Operation component. When creating a new Connector Operation component, select the Import Operation button, and use the Import Wizard to complete the import. The Upload action does not create a Response Profile.
After the operation import, the following option will be available for this action:
- Path – (Required) The path to upload to. This should be the full absolute path including the file name and file extension.
The above option can be configured within the operation itself or can be set dynamically from your process by using Dynamic Operation Properties within the step. The Upload action does not require any Parameters to be configured for the step. The response to this action, represented as a JSON dictionary, may include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| crc32 | String | If available, the CRC32 checksum of the file. |
| created_at | Date-Time | The creation date/time of the file or folder. |
| display_name | String | The name of the file or folder, as displayed to the user. |
| md5 | String | If available, the MD5 checksum of the file. |
| mime_type | String | The MIME type of the file. |
| mtime | Date-Time | The last modification date/time of the item on Files.com. |
| path | String | The path of the file or folder. Must be slash-delimited and neither start nor end with a slash. Maximum length of 5000 characters. |
| permissions | String | A short string representing the connector's permissions. Can be r (Read), w (Write), d (Delete), l (List) or any combination. |
| provided_mtime | Date-Time | If available, the last modification date/time of the item provided to Files.com from the previously hosting system. |
| region | String | The Files.com storage region that the item is stored in. |
| size | Int64 | The size in bytes of the file. |
The above values can be queried, and the results used in subsequent steps of your Boomi process.
Download a file (Deprecated)
This operation is deprecated and has been replaced by the newer Download operation. It remains in the Files.com - Partner connector to provide backwards compatibility for customers who used the previous version of the connector in their processes.
This operation will retrieve the contents of the specified file. This applies to any file on Files.com, including Remote Mount files stored on supported platforms such as Microsoft (Azure Blob, Azure Files, SharePoint, OneDrive), Amazon S3, Google (Cloud and Drive), BackBlaze B2, Rackspace Cloud Files Storage, Wasabi Hot Cloud Storage, any remote FTP site, any remote SFTP site, Box, and Dropbox.
When creating a new Files.com Connector Operation, select a Connection component, then select the Connector Action for Download a file, and select a Connector Operation component.
When creating a new Connector Operation component, select the Import Operation button, and use the Import Wizard to complete the import, and a file object, with an unstructured Response Profile, will be created for you. The Download a file action does not create a Response Profile.
After the operation import, the following Parameters will be available for the connector step:
- ID: (Required) The path to the file. This should be the full absolute folder path including the file name and file extension.
The response result will be the contents of the file, which can used in subsequent steps of your Boomi process.
List folder items (Deprecated)
This operation is deprecated and has been replaced by the newer List operation. It remains in the Files.com - Partner connector to provide backwards compatibility for customers who used the previous version of the connector in their processes.
This operation will list the contents of the specified folder/directory path on the Files.com platform. This applies to any folder on Files.com, including Remote Mount folders from supported platforms such as Microsoft (Azure Blob, Azure Files, SharePoint, OneDrive), Amazon S3, Google (Cloud and Drive), BackBlaze B2, Rackspace Cloud Files Storage, Wasabi Hot Cloud Storage, any remote FTP site, any remote SFTP site, Box, and Dropbox.
When creating a new Files.com Connector Operation, select the Connector Action for List Folder Items.
Select the Import button, use the Import Wizard to complete the import, and a Response Profile will be created for you.
The Per Page option of the operation can be used to limit the returned results to the number of items specified.
Under the Filters tab, click on the triangle icon next to Filter and select Add expression. Select Expression, select the Field option, and choose path. Select an Operator option from either Equals or Wildcard Match.
- The Equals option will configure the operation to expect a path value that will be matched exactly.
- The Wildcard Match option will configure the operation to expect a path value that includes a filename wildcard pattern to be matched.
For example, to list the entire contents of a Files.com folder named /vendor/acme/orders, use a Filter Expression with an Operator of Equals and add a Parameter to your step that has a value of /vendor/acme/orders.
To list only the *.csv files of a Files.com folder named /vendor/acme/orders, use a Filter Expression with an Operator of Wildcard Match and add a Parameter to your step that has a value of /vendor/acme/orders/*.csv.
Each item in the results will be passed on as a separate document to your Boomi process.
The Response Profile for each item, represented as a JSON dictionary, will include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| created_at | Date-Time | The creation date and time of the item. |
| display_name | String | The name of the item, either a file name or a folder name. |
| md5 | String | If available, the md5 checksum value of the item. |
| mtime | Date-Time | The last modified date and time of the item. |
| path | String | The full path of the item. |
| size | Int64 | The size of the item in bytes. |
| type | String | The type of the item. Either directory or file. |
The above Response Profile values can be queried and the results used in subsequent steps of your Boomi process.
Upload a file (Deprecated)
This operation is deprecated and has been replaced by the newer Upload operation. It remains in the Files.com - Partner Connector to provide backwards compatibility for customers who used the previous version of the connector in their processes.
This operation will upload the specified data and save it as a file on the Files.com platform. The uploaded file can be placed into any folder on Files.com, including Remote Mount folders stored on supported platforms such as Microsoft (Azure Blob, Azure Files, SharePoint, OneDrive), Amazon S3, Google (Cloud and Drive), BackBlaze B2, Rackspace Cloud Files Storage, Wasabi Hot Cloud Storage, any remote FTP site, any remote SFTP site, Box, and Dropbox.
When creating a new Files.com Connector Operation, select the Connector Action for Upload a file.
Select the Import button, use the Import Wizard to complete the import, and a file object, with an unstructured Response Profile, will be created for you.
Under the Options tab, you can also specify default values for:
- Upload Path - The folder/directory path on Files.com to upload into.
- Upload Filename - The file name for the uploaded file.
The above values can also be configured as Dynamic Operation Properties in the connector step.
The result of the file upload will be passed on as response data to your subsequent Boomi process steps.
The upload Response Profile, represented as a JSON dictionary, will include the following output keys and values:
| Key | Value Format | Description |
|---|---|---|
| created_at | Date-Time | The creation date and time of the uploaded file. |
| display_name | String | The filename of the uploaded file. |
| md5 | String | If available, the md5 checksum value of the uploaded file. |
| mime_type | String | The MIME type of the uploaded file. |
| mtime | Date-Time | The last modified date and time of the uploaded file. |
| path | String | The full path of the uploaded file. |
| size | Int64 | The size of the uploaded file in bytes. |
The above response values can be queried and used in subsequent steps of your Boomi process.
Archiving tab
See the topic Connector operation’s Archiving tab for more information.
Tracking tab
See the topic Connector operation’s Tracking tab for more information.
Caching tab
See the topic Connector operation’s Caching tab for more information.
Files.com has no file size limits and your use of an archive or cache should take into account that, potentially, huge files could be stored or passed into it.
