Files.com（预览版）

Files.com 连接器提供直接的高性能集成，用于跨Microsoft自动化平台的自动化工作流和集成 Files.com。

此连接器在以下产品和区域中可用：

服务	Class	区域
Copilot Studio	高级	除以下各项外的所有 Power Automate 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）
逻辑应用程序	标准	除以下各项外的所有 逻辑应用区域 ：      - Azure 政府区域      - Azure 中国区域      - 美国国防部（DoD）
Power Apps	高级	除以下各项外的所有 Power Apps 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）
Power Automate	高级	除以下各项外的所有 Power Automate 区域 ：      - 美国政府 （GCC）      - 美国政府 （GCC High）      - 由世纪互联运营的中国云      - 美国国防部（DoD）

联系人​​
Name	Files.com 支持
URL	https://www.files.com/contact
Email	support@files.com

连接器元数据
发布者	Files.com
网站	https://www.files.com/
隐私策略	https://www.files.com/legal/privacy
类别	内容和文件;IT作

Files.com Power Automate 连接器

概述

Files.com 连接器提供从 Microsoft Power Automate 和 Azure 逻辑应用 Files.com 的直接高性能集成。 Files.com 是云原生、下一代 MFT、SFTP 和安全文件共享平台，用于将脆弱的旧服务器替换为一个始终启用的安全构造。 在支持人工协作和消除手动工作的同时，跨任何云、协议或合作伙伴自动执行任务关键型文件流。

注意：此连接器仅提供作，但尚不包括触发器。

⸻

先决条件

使用此连接器之前，请确保具有：1。具有 API 密钥的有效 Files.com 帐户。 2.访问 Microsoft Power Automate。

⸻

Authentication

此连接器使用 API 密钥身份验证。 API 密钥可以在以下 Files.com 帐户中生成：

→创建 API 密钥→ API 密钥的设置。

配置连接器时，请在身份验证字段中输入 Files.com 主机和 API 密钥。

示例：

主机：你的公司 API 密钥：abc123456789...

所有请求都发送到：

https://yourcompany.files.com/api/rest/v1/

⸻

示例用例 1。管理用户和组：创建、更新或停用用户、分配角色，以及直接通过 Power Automate作管理组成员身份。 2.自动执行共享链接（捆绑包）工作流：生成用于文件传递、添加收件人、配置通知或自动撤销访问权限的共享链接。 3.同步文件元数据列表文件夹、检索文件元数据并应用自动化逻辑，例如权限更改或标记。 4.生成用户预配工作流，将 HR 或标识管理系统与 Files.com 集成，以在发生更改时自动创建用户或更新访问权限。 5. 触发文档分发：将 Files.com作与 OneDrive 或 SharePoint 结合使用以安全地分发或存档文档。

⸻

Support

有关连接器设置的技术支持或问题，请联系 Files.com 支持人员 https://www.files.com/contact

有关特定于 Power Automate 的问题，请参阅Microsoft的自定义连接器文档。

⸻

法律声明

此连接器由 Files.com 提供。 使用此连接器，你同意 Files.com 服务条款和隐私策略。

创建连接

连接器支持以下身份验证类型：

默认	用于创建连接的参数。	所有区域	不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name	类型	Description	必选
Files.com API 密钥	securestring	此 API 的 Files.com API 密钥	True

限制

名称	调用	续订期
每个连接的 API 调用数	100	60 秒

操作

为组创建新用户帐户	为组创建新用户帐户
列出共享链接	列出共享链接
列出共享链接下载	列出共享链接下载
列出共享链接收件人	列出共享链接收件人
列出共享链接注册	列出共享链接注册
列出共享链接通知	列出共享链接通知
列出用户	列出用户
列表组	列表组
创建共享链接	创建共享链接
创建共享链接收件人	创建共享链接收件人
创建共享链接通知	创建共享链接通知
创建文件夹	创建文件夹
创建用户	创建用户
创建组	创建组
删除共享链接	删除共享链接
删除共享链接通知	删除共享链接通知
删除文件或文件夹	删除文件或文件夹
删除用户	删除用户
删除组	删除组
复制文件或文件夹	复制文件或文件夹
按路径列出文件夹	按路径列出文件夹
按路径查找文件或文件夹	按路径查找文件或文件夹
显示共享链接	显示共享链接
显示共享链接通知	显示共享链接通知
显示用户	显示用户
显示组	显示组
更新共享链接	更新共享链接
更新共享链接通知	更新共享链接通知
更新用户	更新用户
更新用户	更新用户
更新组	更新组
移动文件或文件夹	移动文件或文件夹

为组创建新用户帐户

操作 ID:

PostGroupsGroupIdUsers

为组创建新用户帐户

参数

名称	密钥	必需	类型	说明
组 ID	group_id	True	integer	要与此用户关联的组 ID。
身份验证方法	authentication_method		string	此用户是如何进行身份验证的？
公司	company		string	用户的公司
Email	email		string	用户的电子邮件。
组 ID	group_ids		string	要与此用户关联的组 ID 列表。 逗号分隔。
Name	name		string	用户的全名
注释	notes		string	用户的任何内部说明
密码	password		string	用户密码。
要求更改密码	require_password_change		boolean	下次用户登录时是否需要更改密码？
用户主页	user_home		string	FTP/SFTP 的主文件夹。 请注意，这不用于 API、桌面或 Web 界面。
用户根	user_root		string	FTP 的根文件夹（如果设置了适当的站点范围设置，则为 SFTP）。 请注意，这不用于 API、桌面或 Web 界面。
用户名	username	True	string	用户的用户名

返回

名称	路径	类型	说明
id	id	integer	用户 ID
用户名	username	string	用户的用户名
admin_group_ids	admin_group_ids	array of integer	此用户是管理员的组 ID 列表
allowed_ips	allowed_ips	string	允许的 IP 列表（如果适用）。 换行符分隔
attachments_permission	attachments_permission	boolean	如果用户 true可以创建捆绑包（即共享链接）。 请改用捆绑包权限。
api_keys_count	api_keys_count	integer	与此用户关联的 API 密钥数
authenticate_until	authenticate_until	string	将停用用户的计划日期或时间
authentication_method	authentication_method	string	此用户是如何进行身份验证的？
avatar_url	avatar_url	string	保存用户的头像的 URL
计费	billable	boolean	这是计费用户记录吗？
billing_permission	billing_permission	boolean	允许用户对帐户、付款和发票执行作？
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	允许此用户跳过站点范围的 IP 黑名单？
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	从用户生命周期规则中免除此用户？
创建时间	created_at	string	创建此用户时
dav_permission	dav_permission	boolean	用户是否可以使用 WebDAV 进行连接？
禁用的	disabled	boolean	用户是否已禁用？ 禁用的用户无法登录，并且不计入计费目的。 用户可以通过站点设置或在特定日期后停用的非活动期后自动禁用。
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	如果用户禁用或过期或处于非活动状态，则返回 true 的计算属性。
电子邮件	email	string	用户电子邮件地址
filesystem_layout	filesystem_layout	string	文件系统布局
first_login_at	first_login_at	string	用户的首次登录时间
ftp_permission	ftp_permission	boolean	用户是否可以使用 FTP 或 FTPS 进行访问？
group_ids	group_ids	string	此用户所属的组 ID 的逗号分隔列表
header_text	header_text	string	要向用户显示 UI 标头中的文本
语言	language	string	首选语言
last_login_at	last_login_at	string	用户最近通过任何协议登录时间
last_web_login_at	last_web_login_at	string	用户最近通过 Web 登录时间
last_ftp_login_at	last_ftp_login_at	string	用户最近通过 FTP 登录时间
last_sftp_login_at	last_sftp_login_at	string	用户最近通过 SFTP 登录时间
last_dav_login_at	last_dav_login_at	string	用户最近通过 WebDAV 登录时间
last_desktop_login_at	last_desktop_login_at	string	用户最近通过桌面应用登录时间
last_restapi_login_at	last_restapi_login_at	string	用户最近通过 Rest API 登录时间
last_api_use_at	last_api_use_at	string	用户的最新 API 使用时间
最后活动时间	last_active_at	string	用户最近的活动时间，这是最新登录、最新 API 使用、启用或创建
last_protocol_cipher	last_protocol_cipher	string	使用的最新协议和密码
lockout_expires	lockout_expires	string	将来用户不再被锁定的时间（如果适用）
姓名	name	string	用户的全名
company	company	string	用户的公司
笔记	notes	string	用户的任何内部说明
notification_daily_send_time	notification_daily_send_time	integer	每日通知应发送到的一天中的一小时。 范围为 0 到 23
office_integration_enabled	office_integration_enabled	boolean	启用与 Office 网页版的集成？
partner_admin	partner_admin	boolean	此用户是否为合作伙伴管理员？
partner_id	partner_id	integer	如果此用户属于合作伙伴，则合作伙伴 ID
partner_name	partner_name	string	如果此用户属于合作伙伴，则合作伙伴的名称
password_set_at	password_set_at	string	上次设置用户密码的时间
password_validity_days	password_validity_days	integer	允许用户使用相同的密码的天数
public_keys_count	public_keys_count	integer	与此用户关联的公钥数
receive_admin_alerts	receive_admin_alerts	boolean	用户是否应收到管理员警报，例如证书过期通知和超额？
require_2fa	require_2fa	string	2FA 所需设置
require_login_by	require_login_by	string	要求用户按指定日期登录，否则将被禁用。
active_2fa	active_2fa	boolean	2fa 是否对用户处于活动状态？
require_password_change	require_password_change	boolean	下次用户登录时是否需要更改密码？
password_expired	password_expired	boolean	用户的密码是否已过期？
readonly_site_admin	readonly_site_admin	boolean	是否允许用户查看此站点的所有（非计费）站点配置？
restapi_permission	restapi_permission	boolean	此用户是否可以访问 Web 应用、桌面应用、SDK 或 REST API？ （所有这些工具都在内部使用 API，因此这是一个统一的权限集。
self_managed	self_managed	boolean	此用户是否管理自己的凭据，或者是共享用户还是机器人用户？
sftp_permission	sftp_permission	boolean	用户是否可以使用 SFTP 进行访问？
site_admin	site_admin	boolean	用户是否是此网站的管理员？
site_id	site_id	integer	站点标识符
skip_welcome_screen	skip_welcome_screen	boolean	跳过 UI 中的欢迎页面？
ssl_required	ssl_required	string	SSL 所需设置
sso_strategy_id	sso_strategy_id	integer	用户的 SSO（单一登录）策略 ID（如果适用）。
subscribe_to_newsletter	subscribe_to_newsletter	boolean	用户是否订阅了新闻稿？
externally_managed	externally_managed	boolean	此用户是否由 SsoStrategy 管理？
tags	tags	string	此用户的标记的逗号分隔列表。 标记用于其他功能，例如 UserLifecycleRules，这些功能可面向特定标记。 标记只能包含小写字母、数字和连字符。
时区	time_zone	string	用户时区
type_of_2fa	type_of_2fa	string	正在使用的 2FA 方法的类型（s），以便以编程方式使用。 将按sms字母顺序排序并按下划线联接的多个值、 totpwebauthnyubiemail、、或多个值。 不指定用户是否具有多个给定方法。
type_of_2fa_for_display	type_of_2fa_for_display	string	正在使用的 2FA 方法的类型（s），格式用于在 UI 中显示。 与不同的是 type_of_2fa，当用户具有相同类型方法的 1 个以上时，此值将明确。
user_root	user_root	string	FTP 的根文件夹（如果设置了适当的站点范围设置，则为 SFTP）。 请注意，这不用于 API、桌面或 Web 界面。
user_home	user_home	string	FTP 或 SFTP 的主文件夹。 请注意，这不用于 API、桌面或 Web 界面。
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	密码过期之前的天数
password_expire_at	password_expire_at	string	密码过期日期/时间

列出共享链接

操作 ID:

GetBundles

列出共享链接

返回

名称	路径	类型	说明
		array of object
代码	code	string	捆绑代码。 此代码构成了公共 URL 的结束部分。
color_left	color_left	string	页面链接和按钮颜色
color_link	color_link	string	顶部栏链接颜色
color_text	color_text	string	页面链接和按钮颜色
color_top	color_top	string	上栏背景色
color_top_text	color_top_text	string	顶部条形图文本颜色
网址	url	string	共享链接的公共 URL
描述	description	string	公共说明
过期时间	expires_at	string	捆绑过期日期或时间
password_protected	password_protected	boolean	此捆绑包密码是否受保护？
权限	permissions	string	应用于此共享链接中的文件夹的权限。
preview_only	preview_only	boolean
require_registration	require_registration	boolean	显示捕获下载程序名称和电子邮件地址的注册页？
require_share_recipient	require_share_recipient	boolean	仅允许通过 Files.com UI 发送的电子邮件显式接收共享的收件人的访问权限？
require_logout	require_logout	boolean	如果为 true，我们将隐藏捆绑包注册页上的“记住我”框，要求用户每次访问页面时注销并重新登录。
clickwrap_body	clickwrap_body	string	在访问捆绑包之前必须同意的法律文本。
id	form_field_set.id	integer	窗体域集 ID
title	form_field_set.title	string	要显示的标题
form_layout	form_field_set.form_layout	array of integer	窗体的布局
form_fields	form_field_set.form_fields	array of object	关联的表单字段
items	form_field_set.form_fields	object
skip_name	form_field_set.skip_name	boolean	无需提供名称即可保存任何关联的 InboxRegistrations 或 BundleRegistrations
skip_email	form_field_set.skip_email	boolean	无需提供电子邮件即可保存任何关联的 InboxRegistrations 或 BundleRegistrations
skip_company	form_field_set.skip_company	boolean	无需提供公司即可保存任何关联的 InboxRegistrations 或 BundleRegistrations
in_use	form_field_set.in_use	boolean	表单字段集由活动收件箱、捆绑包或收件箱注册或捆绑包注册使用
skip_name	skip_name	boolean	可以保存 BundleRegistrations 而不提供名称？
skip_email	skip_email	boolean	可以保存 BundleRegistrations 而不提供电子邮件？
start_access_on_date	start_access_on_date	string	共享开始可访问的日期。 如果在 nil 创建后授予访问权限。
skip_company	skip_company	boolean	可以在不提供公司的情况下保存 BundleRegistration？
id	id	integer	捆绑销售 ID
创建时间	created_at	string	在日期或时间创建的捆绑包
dont_separate_submissions_by_folder	dont_separate_submissions_by_folder	boolean	不要为上传到此共享的文件创建子文件夹。 注意：存在一些细微的安全陷阱，允许多个用户的匿名上传位于同一文件夹中。 除非绝对需要，否则我们强烈建议不要使用此选项。
max_uses	max_uses	integer	可以访问捆绑包的最大次数
注意	note	string	捆绑内部说明
path_template	path_template	string	用于创建提交子文件夹的模板。 可以使用上传程序的名称、电子邮件地址、ip、公司、 strftime 指令和任何自定义表单数据。
path_template_time_zone	path_template_time_zone	string	在路径模板中呈现时间戳时要使用的时区。
send_email_receipt_to_uploader	send_email_receipt_to_uploader	boolean	将送达回执发送到上传程序。 注意：仅适用于可写共享
snapshot_id	snapshot_id	integer	包含此捆绑包内容的快照的 ID。
用户ID	user_id	integer	捆绑创建者用户 ID
用户名	username	string	捆绑创建者用户名
clickwrap_id	clickwrap_id	integer	要用于此捆绑包的 clickwrap 的 ID。
inbox_id	inbox_id	integer	关联的收件箱的 ID（如果可用）。
姓名	watermark_attachment.name	string	映像名称
uri	watermark_attachment.uri	string	映像 URI
watermark_value	watermark_value	object	应用于所有捆绑项的预览水印设置。 使用与 Behavior.value 相同的键
has_inbox	has_inbox	boolean	此捆绑包是否具有关联的收件箱？
dont_allow_folders_in_uploads	dont_allow_folders_in_uploads	boolean	是否应阻止文件夹上传？
路径	paths	array of string	此捆绑包中的路径列表。 出于性能原因，列出捆绑包时不提供此功能。
bundlepaths	bundlepaths	array of object	此捆绑包中的捆绑路径列表。 出于性能原因，列出捆绑包时不提供此功能。
items	bundlepaths	object

列出共享链接下载

操作 ID:

GetBundleDownloads

列出共享链接下载

参数

名称	密钥	必需	类型	说明
捆绑 ID	bundle_id		integer	捆绑销售 ID

返回

名称	路径	类型	说明
		array of object
代码	bundle_registration.code	string	注册 Cookie 代码
姓名	bundle_registration.name	string	注册表名称
company	bundle_registration.company	string	注册公司名称
电子邮件	bundle_registration.email	string	注册电子邮件地址
ip	bundle_registration.ip	string	注册 IP 地址
inbox_code	bundle_registration.inbox_code	string	InboxRegistration Cookie 代码（如果有关联的 InboxRegistration）
clickwrap_body	bundle_registration.clickwrap_body	string	向注册者显示的 Clickwrap 文本
form_field_set_id	bundle_registration.form_field_set_id	integer	关联的表单字段集的 ID
form_field_data	bundle_registration.form_field_data	object	表单字段集的数据，其中窗体字段 ID 作为键，用户数据作为值
bundle_code	bundle_registration.bundle_code	string	捆绑 URL 代码
bundle_id	bundle_registration.bundle_id	integer	关联的捆绑包的 ID
bundle_recipient_id	bundle_registration.bundle_recipient_id	integer	关联的捆绑包收件人的 ID
创建时间	bundle_registration.created_at	string	注册创建日期或时间
download_method	download_method	string	下载方法（文件或full_zip）
路径	path	string	下载路径。 这必须以斜杠分隔，但它不得以斜杠开头或结尾。 最多 5000 个字符。
创建时间	created_at	string	下载日期或时间

列出共享链接收件人

操作 ID:

GetBundleRecipients

列出共享链接收件人

参数

名称	密钥	必需	类型	说明
捆绑 ID	bundle_id	True	integer	列出具有此 ID 的捆绑包的收件人。

返回

名称	路径	类型	说明
		array of object
company	company	string	收件人的公司。
姓名	name	string	收件人的姓名。
注意	note	string	向包含捆绑包的收件人发送的便条。
收件人	recipient	string	收件人的电子邮件地址。
sent_at	sent_at	string	与此收件人共享捆绑包时。

列出共享链接注册

操作 ID:

GetBundleRegistrations

列出共享链接注册

参数

名称	密钥	必需	类型	说明
捆绑 ID	bundle_id		integer	关联的捆绑包的 ID

返回

名称	路径	类型	说明
		array of object
代码	code	string	注册 Cookie 代码
姓名	name	string	注册表名称
company	company	string	注册公司名称
电子邮件	email	string	注册电子邮件地址
ip	ip	string	注册 IP 地址
inbox_code	inbox_code	string	InboxRegistration Cookie 代码（如果有关联的 InboxRegistration）
clickwrap_body	clickwrap_body	string	向注册者显示的 Clickwrap 文本
form_field_set_id	form_field_set_id	integer	关联的表单字段集的 ID
form_field_data	form_field_data	object	表单字段集的数据，其中窗体字段 ID 作为键，用户数据作为值
bundle_code	bundle_code	string	捆绑 URL 代码
bundle_id	bundle_id	integer	关联的捆绑包的 ID
bundle_recipient_id	bundle_recipient_id	integer	关联的捆绑包收件人的 ID
创建时间	created_at	string	注册创建日期或时间

列出共享链接通知

操作 ID:

GetBundleNotifications

列出共享链接通知

返回

名称	路径	类型	说明
		array of object
bundle_id	bundle_id	integer	要通知的捆绑 ID
id	id	integer	捆绑通知 ID
notify_on_registration	notify_on_registration	boolean	在注册作发生时触发捆绑通知。
notify_on_upload	notify_on_upload	boolean	在上传作发生时触发捆绑通知。
notify_user_id	notify_user_id	integer	要通知的用户的 ID。

列出用户

操作 ID:

GetUsers

列出用户

返回

名称	路径	类型	说明
		array of object
id	id	integer	用户 ID
用户名	username	string	用户的用户名
admin_group_ids	admin_group_ids	array of integer	此用户是管理员的组 ID 列表
allowed_ips	allowed_ips	string	允许的 IP 列表（如果适用）。 换行符分隔
attachments_permission	attachments_permission	boolean	如果用户 true可以创建捆绑包（即共享链接）。 请改用捆绑包权限。
api_keys_count	api_keys_count	integer	与此用户关联的 API 密钥数
authenticate_until	authenticate_until	string	将停用用户的计划日期或时间
authentication_method	authentication_method	string	此用户是如何进行身份验证的？
avatar_url	avatar_url	string	保存用户的头像的 URL
计费	billable	boolean	这是计费用户记录吗？
billing_permission	billing_permission	boolean	允许用户对帐户、付款和发票执行作？
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	允许此用户跳过站点范围的 IP 黑名单？
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	从用户生命周期规则中免除此用户？
创建时间	created_at	string	创建此用户时
dav_permission	dav_permission	boolean	用户是否可以使用 WebDAV 进行连接？
禁用的	disabled	boolean	用户是否已禁用？ 禁用的用户无法登录，并且不计入计费目的。 用户可以通过站点设置或在特定日期后停用的非活动期后自动禁用。
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	如果用户禁用或过期或处于非活动状态，则返回 true 的计算属性。
电子邮件	email	string	用户电子邮件地址
filesystem_layout	filesystem_layout	string	文件系统布局
first_login_at	first_login_at	string	用户的首次登录时间
ftp_permission	ftp_permission	boolean	用户是否可以使用 FTP 或 FTPS 进行访问？
group_ids	group_ids	string	此用户所属的组 ID 的逗号分隔列表
header_text	header_text	string	要向用户显示 UI 标头中的文本
语言	language	string	首选语言
last_login_at	last_login_at	string	用户最近通过任何协议登录时间
last_web_login_at	last_web_login_at	string	用户最近通过 Web 登录时间
last_ftp_login_at	last_ftp_login_at	string	用户最近通过 FTP 登录时间
last_sftp_login_at	last_sftp_login_at	string	用户最近通过 SFTP 登录时间
last_dav_login_at	last_dav_login_at	string	用户最近通过 WebDAV 登录时间
last_desktop_login_at	last_desktop_login_at	string	用户最近通过桌面应用登录时间
last_restapi_login_at	last_restapi_login_at	string	用户最近通过 Rest API 登录时间
last_api_use_at	last_api_use_at	string	用户的最新 API 使用时间
最后活动时间	last_active_at	string	用户最近的活动时间，这是最新登录、最新 API 使用、启用或创建
last_protocol_cipher	last_protocol_cipher	string	使用的最新协议和密码
lockout_expires	lockout_expires	string	将来用户不再被锁定的时间（如果适用）
姓名	name	string	用户的全名
company	company	string	用户的公司
笔记	notes	string	用户的任何内部说明
notification_daily_send_time	notification_daily_send_time	integer	每日通知应发送到的一天中的一小时。 范围为 0 到 23
office_integration_enabled	office_integration_enabled	boolean	启用与 Office 网页版的集成？
partner_admin	partner_admin	boolean	此用户是否为合作伙伴管理员？
partner_id	partner_id	integer	如果此用户属于合作伙伴，则合作伙伴 ID
partner_name	partner_name	string	如果此用户属于合作伙伴，则合作伙伴的名称
password_set_at	password_set_at	string	上次设置用户密码的时间
password_validity_days	password_validity_days	integer	允许用户使用相同的密码的天数
public_keys_count	public_keys_count	integer	与此用户关联的公钥数
receive_admin_alerts	receive_admin_alerts	boolean	用户是否应收到管理员警报，例如证书过期通知和超额？
require_2fa	require_2fa	string	2FA 所需设置
require_login_by	require_login_by	string	要求用户按指定日期登录，否则将被禁用。
active_2fa	active_2fa	boolean	2fa 是否对用户处于活动状态？
require_password_change	require_password_change	boolean	下次用户登录时是否需要更改密码？
password_expired	password_expired	boolean	用户的密码是否已过期？
readonly_site_admin	readonly_site_admin	boolean	是否允许用户查看此站点的所有（非计费）站点配置？
restapi_permission	restapi_permission	boolean	此用户是否可以访问 Web 应用、桌面应用、SDK 或 REST API？ （所有这些工具都在内部使用 API，因此这是一个统一的权限集。
self_managed	self_managed	boolean	此用户是否管理自己的凭据，或者是共享用户还是机器人用户？
sftp_permission	sftp_permission	boolean	用户是否可以使用 SFTP 进行访问？
site_admin	site_admin	boolean	用户是否是此网站的管理员？
site_id	site_id	integer	站点标识符
skip_welcome_screen	skip_welcome_screen	boolean	跳过 UI 中的欢迎页面？
ssl_required	ssl_required	string	SSL 所需设置
sso_strategy_id	sso_strategy_id	integer	用户的 SSO（单一登录）策略 ID（如果适用）。
subscribe_to_newsletter	subscribe_to_newsletter	boolean	用户是否订阅了新闻稿？
externally_managed	externally_managed	boolean	此用户是否由 SsoStrategy 管理？
tags	tags	string	此用户的标记的逗号分隔列表。 标记用于其他功能，例如 UserLifecycleRules，这些功能可面向特定标记。 标记只能包含小写字母、数字和连字符。
时区	time_zone	string	用户时区
type_of_2fa	type_of_2fa	string	正在使用的 2FA 方法的类型（s），以便以编程方式使用。 将按sms字母顺序排序并按下划线联接的多个值、 totpwebauthnyubiemail、、或多个值。 不指定用户是否具有多个给定方法。
type_of_2fa_for_display	type_of_2fa_for_display	string	正在使用的 2FA 方法的类型（s），格式用于在 UI 中显示。 与不同的是 type_of_2fa，当用户具有相同类型方法的 1 个以上时，此值将明确。
user_root	user_root	string	FTP 的根文件夹（如果设置了适当的站点范围设置，则为 SFTP）。 请注意，这不用于 API、桌面或 Web 界面。
user_home	user_home	string	FTP 或 SFTP 的主文件夹。 请注意，这不用于 API、桌面或 Web 界面。
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	密码过期之前的天数
password_expire_at	password_expire_at	string	密码过期日期/时间

列表组

操作 ID:

GetGroups

列表组

返回

名称	路径	类型	说明
		array of object
id	id	integer	群组标识符
姓名	name	string	组名称
allowed_ips	allowed_ips	string	允许的 IP 列表（如果适用）。 换行符分隔
admin_ids	admin_ids	string	以逗号分隔的用户 ID 列表（用逗号分隔）
笔记	notes	string	有关此组的说明
user_ids	user_ids	string	属于此组的用户 ID 的逗号分隔列表（用逗号分隔）
usernames	usernames	string	属于此组的用户名的逗号分隔列表（用逗号分隔）
ftp_permission	ftp_permission	boolean	如果为 true，则此组中的用户可以使用 FTP 登录。 这将替代用户级别的 false 值 ftp_permission 。
sftp_permission	sftp_permission	boolean	如果为 true，则此组中的用户可以使用 SFTP 登录。 这将替代用户级别的 false 值 sftp_permission 。
dav_permission	dav_permission	boolean	如果为 true，则此组中的用户可以使用 WebDAV 登录。 这将替代用户级别的 false 值 dav_permission 。
restapi_permission	restapi_permission	boolean	如果为 true，则此组中的用户可以使用 REST API 登录。 这将替代用户级别的 false 值 restapi_permission 。
site_id	site_id	integer	站点标识符

创建共享链接

操作 ID:

PostBundles

创建共享链接

参数

名称	密钥	必需	类型	说明
Description	description		string	公共说明
到期时间	expires_at		date-time	捆绑过期日期/时间
最大使用数	max_uses		integer	可以访问捆绑包的最大次数
注释	note		string	捆绑内部说明
密码	password		string	此捆绑包的密码。
路径	paths	True	array of string	要包含在此捆绑包中的路径列表。
需要注册	require_registration		boolean	显示捕获下载程序名称和电子邮件地址的注册页？

返回

名称	路径	类型	说明
代码	code	string	捆绑代码。 此代码构成了公共 URL 的结束部分。
color_left	color_left	string	页面链接和按钮颜色
color_link	color_link	string	顶部栏链接颜色
color_text	color_text	string	页面链接和按钮颜色
color_top	color_top	string	上栏背景色
color_top_text	color_top_text	string	顶部条形图文本颜色
网址	url	string	共享链接的公共 URL
描述	description	string	公共说明
过期时间	expires_at	string	捆绑过期日期或时间
password_protected	password_protected	boolean	此捆绑包密码是否受保护？
权限	permissions	string	应用于此共享链接中的文件夹的权限。
preview_only	preview_only	boolean
require_registration	require_registration	boolean	显示捕获下载程序名称和电子邮件地址的注册页？
require_share_recipient	require_share_recipient	boolean	仅允许通过 Files.com UI 发送的电子邮件显式接收共享的收件人的访问权限？
require_logout	require_logout	boolean	如果为 true，我们将隐藏捆绑包注册页上的“记住我”框，要求用户每次访问页面时注销并重新登录。
clickwrap_body	clickwrap_body	string	在访问捆绑包之前必须同意的法律文本。
id	form_field_set.id	integer	窗体域集 ID
title	form_field_set.title	string	要显示的标题
form_layout	form_field_set.form_layout	array of integer	窗体的布局
form_fields	form_field_set.form_fields	array of object	关联的表单字段
items	form_field_set.form_fields	object
skip_name	form_field_set.skip_name	boolean	无需提供名称即可保存任何关联的 InboxRegistrations 或 BundleRegistrations
skip_email	form_field_set.skip_email	boolean	无需提供电子邮件即可保存任何关联的 InboxRegistrations 或 BundleRegistrations
skip_company	form_field_set.skip_company	boolean	无需提供公司即可保存任何关联的 InboxRegistrations 或 BundleRegistrations
in_use	form_field_set.in_use	boolean	表单字段集由活动收件箱、捆绑包或收件箱注册或捆绑包注册使用
skip_name	skip_name	boolean	可以保存 BundleRegistrations 而不提供名称？
skip_email	skip_email	boolean	可以保存 BundleRegistrations 而不提供电子邮件？
start_access_on_date	start_access_on_date	string	共享开始可访问的日期。 如果在 nil 创建后授予访问权限。
skip_company	skip_company	boolean	可以在不提供公司的情况下保存 BundleRegistration？
id	id	integer	捆绑销售 ID
创建时间	created_at	string	在日期或时间创建的捆绑包
dont_separate_submissions_by_folder	dont_separate_submissions_by_folder	boolean	不要为上传到此共享的文件创建子文件夹。 注意：存在一些细微的安全陷阱，允许多个用户的匿名上传位于同一文件夹中。 除非绝对需要，否则我们强烈建议不要使用此选项。
max_uses	max_uses	integer	可以访问捆绑包的最大次数
注意	note	string	捆绑内部说明
path_template	path_template	string	用于创建提交子文件夹的模板。 可以使用上传程序的名称、电子邮件地址、ip、公司、 strftime 指令和任何自定义表单数据。
path_template_time_zone	path_template_time_zone	string	在路径模板中呈现时间戳时要使用的时区。
send_email_receipt_to_uploader	send_email_receipt_to_uploader	boolean	将送达回执发送到上传程序。 注意：仅适用于可写共享
snapshot_id	snapshot_id	integer	包含此捆绑包内容的快照的 ID。
用户ID	user_id	integer	捆绑创建者用户 ID
用户名	username	string	捆绑创建者用户名
clickwrap_id	clickwrap_id	integer	要用于此捆绑包的 clickwrap 的 ID。
inbox_id	inbox_id	integer	关联的收件箱的 ID（如果可用）。
姓名	watermark_attachment.name	string	映像名称
uri	watermark_attachment.uri	string	映像 URI
watermark_value	watermark_value	object	应用于所有捆绑项的预览水印设置。 使用与 Behavior.value 相同的键
has_inbox	has_inbox	boolean	此捆绑包是否具有关联的收件箱？
dont_allow_folders_in_uploads	dont_allow_folders_in_uploads	boolean	是否应阻止文件夹上传？
路径	paths	array of string	此捆绑包中的路径列表。 出于性能原因，列出捆绑包时不提供此功能。
bundlepaths	bundlepaths	array of object	此捆绑包中的捆绑路径列表。 出于性能原因，列出捆绑包时不提供此功能。
items	bundlepaths	object

创建共享链接收件人

操作 ID:

PostBundleRecipients

创建共享链接收件人

参数

名称	密钥	必需	类型	说明
捆绑 ID	bundle_id	True	integer	要共享的捆绑包。
公司	company		string	收件人公司。
Name	name		string	收件人姓名。
注释	note		string	请注意，请包含在电子邮件中。
Recipient	recipient	True	string	要与之共享此捆绑包的电子邮件地址。

返回

名称	路径	类型	说明
company	company	string	收件人的公司。
姓名	name	string	收件人的姓名。
注意	note	string	向包含捆绑包的收件人发送的便条。
收件人	recipient	string	收件人的电子邮件地址。
sent_at	sent_at	string	与此收件人共享捆绑包时。

创建共享链接通知

操作 ID:

PostBundleNotifications

创建共享链接通知

参数

名称	密钥	必需	类型	说明
捆绑 ID	bundle_id	True	integer	要通知的捆绑 ID
通知用户 ID	notify_user_id		integer	要通知的用户的 ID。

返回

名称	路径	类型	说明
bundle_id	bundle_id	integer	要通知的捆绑 ID
id	id	integer	捆绑通知 ID
notify_on_registration	notify_on_registration	boolean	在注册作发生时触发捆绑通知。
notify_on_upload	notify_on_upload	boolean	在上传作发生时触发捆绑通知。
notify_user_id	notify_user_id	integer	要通知的用户的 ID。

创建文件夹

操作 ID:

PostFoldersPath

创建文件夹

参数

名称	密钥	必需	类型	说明
路径	path	True	string	要作的路径。

返回

名称	路径	类型	说明
路径	path	string	文件或文件夹路径。 这必须以斜杠分隔，但它不得以斜杠开头或结尾。 最多 5000 个字符。
created_by_id	created_by_id	integer	创建文件或文件夹的用户的用户 ID
created_by_api_key_id	created_by_api_key_id	integer	创建文件或文件夹的 API 密钥的 ID
created_by_as2_incoming_message_id	created_by_as2_incoming_message_id	integer	创建文件或文件夹的 AS2 传入邮件的 ID
created_by_automation_id	created_by_automation_id	integer	创建文件或文件夹的自动化的 ID
created_by_bundle_registration_id	created_by_bundle_registration_id	integer	创建文件或文件夹的捆绑注册的 ID
created_by_inbox_id	created_by_inbox_id	integer	创建文件或文件夹的收件箱的 ID
created_by_remote_server_id	created_by_remote_server_id	integer	创建文件或文件夹的远程服务器的 ID
created_by_remote_server_sync_id	created_by_remote_server_sync_id	integer	创建文件或文件夹的远程服务器同步的 ID
custom_metadata	custom_metadata	object	键和值的自定义元数据映射。 限制为 32 个键，每个键 256 个字符，每个值 1024 个字符。
display_name	display_name	string	文件或文件夹显示名称
类型	type	string	类型： directory 或 file。
size	size	integer	文件或文件夹大小
创建时间	created_at	string	文件创建日期或时间
last_modified_by_id	last_modified_by_id	integer	上次修改文件或文件夹的用户的用户 ID
last_modified_by_api_key_id	last_modified_by_api_key_id	integer	上次修改文件或文件夹的 API 密钥的 ID
last_modified_by_automation_id	last_modified_by_automation_id	integer	上次修改文件或文件夹的自动化的 ID
last_modified_by_bundle_registration_id	last_modified_by_bundle_registration_id	integer	上次修改文件或文件夹的捆绑注册的 ID
last_modified_by_remote_server_id	last_modified_by_remote_server_id	integer	上次修改文件或文件夹的远程服务器的 ID
last_modified_by_remote_server_sync_id	last_modified_by_remote_server_sync_id	integer	上次修改文件或文件夹的远程服务器同步的 ID
mtime	mtime	string	根据服务器的文件上次修改日期或时间。 这是文件上一 Files.com作的时间戳，无论发送了修改后的时间戳。
provided_mtime	provided_mtime	string	根据设置文件的客户端，文件上次修改的日期或时间。 Files.com 允许桌面、FTP、SFTP 和 WebDAV 客户端有时设置修改。 这样，桌面<云>同步可以保留修改的时间。
crc32	crc32	string	文件 CRC32 校验和。 这有时会延迟，因此，如果收到空白响应，请等待并重试。
md5	md5	string	文件 MD5 校验和。 这有时会延迟，因此，如果收到空白响应，请等待并重试。
sha1	sha1	string	文件 SHA1 校验和。 这有时会延迟，因此，如果收到空白响应，请等待并重试。
sha256	sha256	string	文件 SHA256 校验和。 这有时会延迟，因此，如果收到空白响应，请等待并重试。
mime_type	mime_type	string	MIME 类型。 这是由文件扩展名确定的，不会在内部单独存储。
区域	region	string	区域位置
权限	permissions	string	一个表示当前用户权限的短字符串。 可以是 r （读取）、w （写入）、d （删除）、 l （列表）或任何组合
subfolders_locked？	subfolders_locked?	boolean	子文件夹是否锁定且无法修改？
is_locked	is_locked	boolean	此文件夹是否已锁定且无法修改？
download_uri	download_uri	string	下载文件的链接。 仅在响应下载请求时提供。
priority_color	priority_color	string	文件或文件夹的书签或优先级颜色
preview_id	preview_id	integer	文件预览 ID
id	preview.id	integer	预览 ID
状态	preview.status	string	预览状态。 可能无效、not_generated、生成、完成或file_too_large
download_uri	preview.download_uri	string	下载预览版的链接
类型	preview.type	string	预览类型。 可以是图像、pdf、pdf_native、视频或音频
size	preview.size	string	预览大小

创建用户

操作 ID:

PostUsers

创建用户

参数

名称	密钥	必需	类型	说明
身份验证方法	authentication_method		string	此用户是如何进行身份验证的？
公司	company		string	用户的公司
Email	email		string	用户的电子邮件。
组 ID	group_ids		string	要与此用户关联的组 ID 列表。 逗号分隔。
Name	name		string	用户的全名
注释	notes		string	用户的任何内部说明
密码	password		string	用户密码。
要求更改密码	require_password_change		boolean	下次用户登录时是否需要更改密码？
用户主页	user_home		string	FTP/SFTP 的主文件夹。 请注意，这不用于 API、桌面或 Web 界面。
用户根	user_root		string	FTP 的根文件夹（如果设置了适当的站点范围设置，则为 SFTP）。 请注意，这不用于 API、桌面或 Web 界面。
用户名	username	True	string	用户的用户名

返回

名称	路径	类型	说明
id	id	integer	用户 ID
用户名	username	string	用户的用户名
admin_group_ids	admin_group_ids	array of integer	此用户是管理员的组 ID 列表
allowed_ips	allowed_ips	string	允许的 IP 列表（如果适用）。 换行符分隔
attachments_permission	attachments_permission	boolean	如果用户 true可以创建捆绑包（即共享链接）。 请改用捆绑包权限。
api_keys_count	api_keys_count	integer	与此用户关联的 API 密钥数
authenticate_until	authenticate_until	string	将停用用户的计划日期或时间
authentication_method	authentication_method	string	此用户是如何进行身份验证的？
avatar_url	avatar_url	string	保存用户的头像的 URL
计费	billable	boolean	这是计费用户记录吗？
billing_permission	billing_permission	boolean	允许用户对帐户、付款和发票执行作？
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	允许此用户跳过站点范围的 IP 黑名单？
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	从用户生命周期规则中免除此用户？
创建时间	created_at	string	创建此用户时
dav_permission	dav_permission	boolean	用户是否可以使用 WebDAV 进行连接？
禁用的	disabled	boolean	用户是否已禁用？ 禁用的用户无法登录，并且不计入计费目的。 用户可以通过站点设置或在特定日期后停用的非活动期后自动禁用。
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	如果用户禁用或过期或处于非活动状态，则返回 true 的计算属性。
电子邮件	email	string	用户电子邮件地址
filesystem_layout	filesystem_layout	string	文件系统布局
first_login_at	first_login_at	string	用户的首次登录时间
ftp_permission	ftp_permission	boolean	用户是否可以使用 FTP 或 FTPS 进行访问？
group_ids	group_ids	string	此用户所属的组 ID 的逗号分隔列表
header_text	header_text	string	要向用户显示 UI 标头中的文本
语言	language	string	首选语言
last_login_at	last_login_at	string	用户最近通过任何协议登录时间
last_web_login_at	last_web_login_at	string	用户最近通过 Web 登录时间
last_ftp_login_at	last_ftp_login_at	string	用户最近通过 FTP 登录时间
last_sftp_login_at	last_sftp_login_at	string	用户最近通过 SFTP 登录时间
last_dav_login_at	last_dav_login_at	string	用户最近通过 WebDAV 登录时间
last_desktop_login_at	last_desktop_login_at	string	用户最近通过桌面应用登录时间
last_restapi_login_at	last_restapi_login_at	string	用户最近通过 Rest API 登录时间
last_api_use_at	last_api_use_at	string	用户的最新 API 使用时间
最后活动时间	last_active_at	string	用户最近的活动时间，这是最新登录、最新 API 使用、启用或创建
last_protocol_cipher	last_protocol_cipher	string	使用的最新协议和密码
lockout_expires	lockout_expires	string	将来用户不再被锁定的时间（如果适用）
姓名	name	string	用户的全名
company	company	string	用户的公司
笔记	notes	string	用户的任何内部说明
notification_daily_send_time	notification_daily_send_time	integer	每日通知应发送到的一天中的一小时。 范围为 0 到 23
office_integration_enabled	office_integration_enabled	boolean	启用与 Office 网页版的集成？
partner_admin	partner_admin	boolean	此用户是否为合作伙伴管理员？
partner_id	partner_id	integer	如果此用户属于合作伙伴，则合作伙伴 ID
partner_name	partner_name	string	如果此用户属于合作伙伴，则合作伙伴的名称
password_set_at	password_set_at	string	上次设置用户密码的时间
password_validity_days	password_validity_days	integer	允许用户使用相同的密码的天数
public_keys_count	public_keys_count	integer	与此用户关联的公钥数
receive_admin_alerts	receive_admin_alerts	boolean	用户是否应收到管理员警报，例如证书过期通知和超额？
require_2fa	require_2fa	string	2FA 所需设置
require_login_by	require_login_by	string	要求用户按指定日期登录，否则将被禁用。
active_2fa	active_2fa	boolean	2fa 是否对用户处于活动状态？
require_password_change	require_password_change	boolean	下次用户登录时是否需要更改密码？
password_expired	password_expired	boolean	用户的密码是否已过期？
readonly_site_admin	readonly_site_admin	boolean	是否允许用户查看此站点的所有（非计费）站点配置？
restapi_permission	restapi_permission	boolean	此用户是否可以访问 Web 应用、桌面应用、SDK 或 REST API？ （所有这些工具都在内部使用 API，因此这是一个统一的权限集。
self_managed	self_managed	boolean	此用户是否管理自己的凭据，或者是共享用户还是机器人用户？
sftp_permission	sftp_permission	boolean	用户是否可以使用 SFTP 进行访问？
site_admin	site_admin	boolean	用户是否是此网站的管理员？
site_id	site_id	integer	站点标识符
skip_welcome_screen	skip_welcome_screen	boolean	跳过 UI 中的欢迎页面？
ssl_required	ssl_required	string	SSL 所需设置
sso_strategy_id	sso_strategy_id	integer	用户的 SSO（单一登录）策略 ID（如果适用）。
subscribe_to_newsletter	subscribe_to_newsletter	boolean	用户是否订阅了新闻稿？
externally_managed	externally_managed	boolean	此用户是否由 SsoStrategy 管理？
tags	tags	string	此用户的标记的逗号分隔列表。 标记用于其他功能，例如 UserLifecycleRules，这些功能可面向特定标记。 标记只能包含小写字母、数字和连字符。
时区	time_zone	string	用户时区
type_of_2fa	type_of_2fa	string	正在使用的 2FA 方法的类型（s），以便以编程方式使用。 将按sms字母顺序排序并按下划线联接的多个值、 totpwebauthnyubiemail、、或多个值。 不指定用户是否具有多个给定方法。
type_of_2fa_for_display	type_of_2fa_for_display	string	正在使用的 2FA 方法的类型（s），格式用于在 UI 中显示。 与不同的是 type_of_2fa，当用户具有相同类型方法的 1 个以上时，此值将明确。
user_root	user_root	string	FTP 的根文件夹（如果设置了适当的站点范围设置，则为 SFTP）。 请注意，这不用于 API、桌面或 Web 界面。
user_home	user_home	string	FTP 或 SFTP 的主文件夹。 请注意，这不用于 API、桌面或 Web 界面。
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	密码过期之前的天数
password_expire_at	password_expire_at	string	密码过期日期/时间

创建组

操作 ID:

PostGroups

创建组

参数

名称	密钥	必需	类型	说明
管理员 ID	admin_ids		string	组管理员用户 ID 的列表。 如果以字符串的形式发送，应以逗号分隔。
Name	name	True	string	组名称。
注释	notes		string	组备注。
用户 ID	user_ids		string	用户 ID 的列表。 如果以字符串的形式发送，应以逗号分隔。

返回

名称	路径	类型	说明
id	id	integer	群组标识符
姓名	name	string	组名称
allowed_ips	allowed_ips	string	允许的 IP 列表（如果适用）。 换行符分隔
admin_ids	admin_ids	string	以逗号分隔的用户 ID 列表（用逗号分隔）
笔记	notes	string	有关此组的说明
user_ids	user_ids	string	属于此组的用户 ID 的逗号分隔列表（用逗号分隔）
usernames	usernames	string	属于此组的用户名的逗号分隔列表（用逗号分隔）
ftp_permission	ftp_permission	boolean	如果为 true，则此组中的用户可以使用 FTP 登录。 这将替代用户级别的 false 值 ftp_permission 。
sftp_permission	sftp_permission	boolean	如果为 true，则此组中的用户可以使用 SFTP 登录。 这将替代用户级别的 false 值 sftp_permission 。
dav_permission	dav_permission	boolean	如果为 true，则此组中的用户可以使用 WebDAV 登录。 这将替代用户级别的 false 值 dav_permission 。
restapi_permission	restapi_permission	boolean	如果为 true，则此组中的用户可以使用 REST API 登录。 这将替代用户级别的 false 值 restapi_permission 。
site_id	site_id	integer	站点标识符

删除共享链接

操作 ID:

DeleteBundlesId

删除共享链接

参数

名称	密钥	必需	类型	说明
Id	id	True	integer	捆绑 ID。

删除共享链接通知

操作 ID:

DeleteBundleNotificationsId

删除共享链接通知

参数

名称	密钥	必需	类型	说明
Id	id	True	integer	捆绑通知 ID。

删除文件或文件夹

操作 ID:

DeleteFilesPath

删除文件或文件夹

参数

名称	密钥	必需	类型	说明
路径	path	True	string	要作的路径。

删除用户

操作 ID:

DeleteUsersId

删除用户

参数

名称	密钥	必需	类型	说明
Id	id	True	integer	用户 ID。

删除组

操作 ID:

DeleteGroupsId

删除组

参数

名称	密钥	必需	类型	说明
Id	id	True	integer	组 ID。

复制文件或文件夹

操作 ID:

FileActionCopy

复制文件或文件夹

参数

名称	密钥	必需	类型	说明
路径	path	True	string	要作的路径。
目的地	destination	True	string	复制目标路径。

返回

名称	路径	类型	说明
状态	status	string	文件作的状态。
file_migration_id	file_migration_id	integer	如果状态处于挂起状态，则这是文件迁移的 ID，用于检查状态更新。

按路径列出文件夹

操作 ID:

FolderListForPath

按路径列出文件夹

参数

名称	密钥	必需	类型	说明
路径	path	True	string	要作的路径。

返回

名称	路径	类型	说明
		array of object
路径	path	string	文件或文件夹路径。 这必须以斜杠分隔，但它不得以斜杠开头或结尾。 最多 5000 个字符。
created_by_id	created_by_id	integer	创建文件或文件夹的用户的用户 ID
created_by_api_key_id	created_by_api_key_id	integer	创建文件或文件夹的 API 密钥的 ID
created_by_as2_incoming_message_id	created_by_as2_incoming_message_id	integer	创建文件或文件夹的 AS2 传入邮件的 ID
created_by_automation_id	created_by_automation_id	integer	创建文件或文件夹的自动化的 ID
created_by_bundle_registration_id	created_by_bundle_registration_id	integer	创建文件或文件夹的捆绑注册的 ID
created_by_inbox_id	created_by_inbox_id	integer	创建文件或文件夹的收件箱的 ID
created_by_remote_server_id	created_by_remote_server_id	integer	创建文件或文件夹的远程服务器的 ID
created_by_remote_server_sync_id	created_by_remote_server_sync_id	integer	创建文件或文件夹的远程服务器同步的 ID
custom_metadata	custom_metadata	object	键和值的自定义元数据映射。 限制为 32 个键，每个键 256 个字符，每个值 1024 个字符。
display_name	display_name	string	文件或文件夹显示名称
类型	type	string	类型： directory 或 file。
size	size	integer	文件或文件夹大小
创建时间	created_at	string	文件创建日期或时间
last_modified_by_id	last_modified_by_id	integer	上次修改文件或文件夹的用户的用户 ID
last_modified_by_api_key_id	last_modified_by_api_key_id	integer	上次修改文件或文件夹的 API 密钥的 ID
last_modified_by_automation_id	last_modified_by_automation_id	integer	上次修改文件或文件夹的自动化的 ID
last_modified_by_bundle_registration_id	last_modified_by_bundle_registration_id	integer	上次修改文件或文件夹的捆绑注册的 ID
last_modified_by_remote_server_id	last_modified_by_remote_server_id	integer	上次修改文件或文件夹的远程服务器的 ID
last_modified_by_remote_server_sync_id	last_modified_by_remote_server_sync_id	integer	上次修改文件或文件夹的远程服务器同步的 ID
mtime	mtime	string	根据服务器的文件上次修改日期或时间。 这是文件上一 Files.com作的时间戳，无论发送了修改后的时间戳。
provided_mtime	provided_mtime	string	根据设置文件的客户端，文件上次修改的日期或时间。 Files.com 允许桌面、FTP、SFTP 和 WebDAV 客户端有时设置修改。 这样，桌面<云>同步可以保留修改的时间。
crc32	crc32	string	文件 CRC32 校验和。 这有时会延迟，因此，如果收到空白响应，请等待并重试。
md5	md5	string	文件 MD5 校验和。 这有时会延迟，因此，如果收到空白响应，请等待并重试。
sha1	sha1	string	文件 SHA1 校验和。 这有时会延迟，因此，如果收到空白响应，请等待并重试。
sha256	sha256	string	文件 SHA256 校验和。 这有时会延迟，因此，如果收到空白响应，请等待并重试。
mime_type	mime_type	string	MIME 类型。 这是由文件扩展名确定的，不会在内部单独存储。
区域	region	string	区域位置
权限	permissions	string	一个表示当前用户权限的短字符串。 可以是 r （读取）、w （写入）、d （删除）、 l （列表）或任何组合
subfolders_locked？	subfolders_locked?	boolean	子文件夹是否锁定且无法修改？
is_locked	is_locked	boolean	此文件夹是否已锁定且无法修改？
download_uri	download_uri	string	下载文件的链接。 仅在响应下载请求时提供。
priority_color	priority_color	string	文件或文件夹的书签或优先级颜色
preview_id	preview_id	integer	文件预览 ID
id	preview.id	integer	预览 ID
状态	preview.status	string	预览状态。 可能无效、not_generated、生成、完成或file_too_large
download_uri	preview.download_uri	string	下载预览版的链接
类型	preview.type	string	预览类型。 可以是图像、pdf、pdf_native、视频或音频
size	preview.size	string	预览大小

按路径查找文件或文件夹

操作 ID:

FileActionFind

按路径查找文件或文件夹

参数

名称	密钥	必需	类型	说明
路径	path	True	string	要作的路径。

返回

名称	路径	类型	说明
路径	path	string	文件或文件夹路径。 这必须以斜杠分隔，但它不得以斜杠开头或结尾。 最多 5000 个字符。
created_by_id	created_by_id	integer	创建文件或文件夹的用户的用户 ID
created_by_api_key_id	created_by_api_key_id	integer	创建文件或文件夹的 API 密钥的 ID
created_by_as2_incoming_message_id	created_by_as2_incoming_message_id	integer	创建文件或文件夹的 AS2 传入邮件的 ID
created_by_automation_id	created_by_automation_id	integer	创建文件或文件夹的自动化的 ID
created_by_bundle_registration_id	created_by_bundle_registration_id	integer	创建文件或文件夹的捆绑注册的 ID
created_by_inbox_id	created_by_inbox_id	integer	创建文件或文件夹的收件箱的 ID
created_by_remote_server_id	created_by_remote_server_id	integer	创建文件或文件夹的远程服务器的 ID
created_by_remote_server_sync_id	created_by_remote_server_sync_id	integer	创建文件或文件夹的远程服务器同步的 ID
custom_metadata	custom_metadata	object	键和值的自定义元数据映射。 限制为 32 个键，每个键 256 个字符，每个值 1024 个字符。
display_name	display_name	string	文件或文件夹显示名称
类型	type	string	类型： directory 或 file。
size	size	integer	文件或文件夹大小
创建时间	created_at	string	文件创建日期或时间
last_modified_by_id	last_modified_by_id	integer	上次修改文件或文件夹的用户的用户 ID
last_modified_by_api_key_id	last_modified_by_api_key_id	integer	上次修改文件或文件夹的 API 密钥的 ID
last_modified_by_automation_id	last_modified_by_automation_id	integer	上次修改文件或文件夹的自动化的 ID
last_modified_by_bundle_registration_id	last_modified_by_bundle_registration_id	integer	上次修改文件或文件夹的捆绑注册的 ID
last_modified_by_remote_server_id	last_modified_by_remote_server_id	integer	上次修改文件或文件夹的远程服务器的 ID
last_modified_by_remote_server_sync_id	last_modified_by_remote_server_sync_id	integer	上次修改文件或文件夹的远程服务器同步的 ID
mtime	mtime	string	根据服务器的文件上次修改日期或时间。 这是文件上一 Files.com作的时间戳，无论发送了修改后的时间戳。
provided_mtime	provided_mtime	string	根据设置文件的客户端，文件上次修改的日期或时间。 Files.com 允许桌面、FTP、SFTP 和 WebDAV 客户端有时设置修改。 这样，桌面<云>同步可以保留修改的时间。
crc32	crc32	string	文件 CRC32 校验和。 这有时会延迟，因此，如果收到空白响应，请等待并重试。
md5	md5	string	文件 MD5 校验和。 这有时会延迟，因此，如果收到空白响应，请等待并重试。
sha1	sha1	string	文件 SHA1 校验和。 这有时会延迟，因此，如果收到空白响应，请等待并重试。
sha256	sha256	string	文件 SHA256 校验和。 这有时会延迟，因此，如果收到空白响应，请等待并重试。
mime_type	mime_type	string	MIME 类型。 这是由文件扩展名确定的，不会在内部单独存储。
区域	region	string	区域位置
权限	permissions	string	一个表示当前用户权限的短字符串。 可以是 r （读取）、w （写入）、d （删除）、 l （列表）或任何组合
subfolders_locked？	subfolders_locked?	boolean	子文件夹是否锁定且无法修改？
is_locked	is_locked	boolean	此文件夹是否已锁定且无法修改？
download_uri	download_uri	string	下载文件的链接。 仅在响应下载请求时提供。
priority_color	priority_color	string	文件或文件夹的书签或优先级颜色
preview_id	preview_id	integer	文件预览 ID
id	preview.id	integer	预览 ID
状态	preview.status	string	预览状态。 可能无效、not_generated、生成、完成或file_too_large
download_uri	preview.download_uri	string	下载预览版的链接
类型	preview.type	string	预览类型。 可以是图像、pdf、pdf_native、视频或音频
size	preview.size	string	预览大小

显示共享链接

操作 ID:

GetBundlesId

显示共享链接

参数

名称	密钥	必需	类型	说明
Id	id	True	integer	捆绑 ID。

返回

名称	路径	类型	说明
代码	code	string	捆绑代码。 此代码构成了公共 URL 的结束部分。
color_left	color_left	string	页面链接和按钮颜色
color_link	color_link	string	顶部栏链接颜色
color_text	color_text	string	页面链接和按钮颜色
color_top	color_top	string	上栏背景色
color_top_text	color_top_text	string	顶部条形图文本颜色
网址	url	string	共享链接的公共 URL
描述	description	string	公共说明
过期时间	expires_at	string	捆绑过期日期或时间
password_protected	password_protected	boolean	此捆绑包密码是否受保护？
权限	permissions	string	应用于此共享链接中的文件夹的权限。
preview_only	preview_only	boolean
require_registration	require_registration	boolean	显示捕获下载程序名称和电子邮件地址的注册页？
require_share_recipient	require_share_recipient	boolean	仅允许通过 Files.com UI 发送的电子邮件显式接收共享的收件人的访问权限？
require_logout	require_logout	boolean	如果为 true，我们将隐藏捆绑包注册页上的“记住我”框，要求用户每次访问页面时注销并重新登录。
clickwrap_body	clickwrap_body	string	在访问捆绑包之前必须同意的法律文本。
id	form_field_set.id	integer	窗体域集 ID
title	form_field_set.title	string	要显示的标题
form_layout	form_field_set.form_layout	array of integer	窗体的布局
form_fields	form_field_set.form_fields	array of object	关联的表单字段
items	form_field_set.form_fields	object
skip_name	form_field_set.skip_name	boolean	无需提供名称即可保存任何关联的 InboxRegistrations 或 BundleRegistrations
skip_email	form_field_set.skip_email	boolean	无需提供电子邮件即可保存任何关联的 InboxRegistrations 或 BundleRegistrations
skip_company	form_field_set.skip_company	boolean	无需提供公司即可保存任何关联的 InboxRegistrations 或 BundleRegistrations
in_use	form_field_set.in_use	boolean	表单字段集由活动收件箱、捆绑包或收件箱注册或捆绑包注册使用
skip_name	skip_name	boolean	可以保存 BundleRegistrations 而不提供名称？
skip_email	skip_email	boolean	可以保存 BundleRegistrations 而不提供电子邮件？
start_access_on_date	start_access_on_date	string	共享开始可访问的日期。 如果在 nil 创建后授予访问权限。
skip_company	skip_company	boolean	可以在不提供公司的情况下保存 BundleRegistration？
id	id	integer	捆绑销售 ID
创建时间	created_at	string	在日期或时间创建的捆绑包
dont_separate_submissions_by_folder	dont_separate_submissions_by_folder	boolean	不要为上传到此共享的文件创建子文件夹。 注意：存在一些细微的安全陷阱，允许多个用户的匿名上传位于同一文件夹中。 除非绝对需要，否则我们强烈建议不要使用此选项。
max_uses	max_uses	integer	可以访问捆绑包的最大次数
注意	note	string	捆绑内部说明
path_template	path_template	string	用于创建提交子文件夹的模板。 可以使用上传程序的名称、电子邮件地址、ip、公司、 strftime 指令和任何自定义表单数据。
path_template_time_zone	path_template_time_zone	string	在路径模板中呈现时间戳时要使用的时区。
send_email_receipt_to_uploader	send_email_receipt_to_uploader	boolean	将送达回执发送到上传程序。 注意：仅适用于可写共享
snapshot_id	snapshot_id	integer	包含此捆绑包内容的快照的 ID。
用户ID	user_id	integer	捆绑创建者用户 ID
用户名	username	string	捆绑创建者用户名
clickwrap_id	clickwrap_id	integer	要用于此捆绑包的 clickwrap 的 ID。
inbox_id	inbox_id	integer	关联的收件箱的 ID（如果可用）。
姓名	watermark_attachment.name	string	映像名称
uri	watermark_attachment.uri	string	映像 URI
watermark_value	watermark_value	object	应用于所有捆绑项的预览水印设置。 使用与 Behavior.value 相同的键
has_inbox	has_inbox	boolean	此捆绑包是否具有关联的收件箱？
dont_allow_folders_in_uploads	dont_allow_folders_in_uploads	boolean	是否应阻止文件夹上传？
路径	paths	array of string	此捆绑包中的路径列表。 出于性能原因，列出捆绑包时不提供此功能。
bundlepaths	bundlepaths	array of object	此捆绑包中的捆绑路径列表。 出于性能原因，列出捆绑包时不提供此功能。
items	bundlepaths	object

显示共享链接通知

操作 ID:

GetBundleNotificationsId

显示共享链接通知

参数

名称	密钥	必需	类型	说明
Id	id	True	integer	捆绑通知 ID。

返回

名称	路径	类型	说明
bundle_id	bundle_id	integer	要通知的捆绑 ID
id	id	integer	捆绑通知 ID
notify_on_registration	notify_on_registration	boolean	在注册作发生时触发捆绑通知。
notify_on_upload	notify_on_upload	boolean	在上传作发生时触发捆绑通知。
notify_user_id	notify_user_id	integer	要通知的用户的 ID。

显示用户

操作 ID:

GetUsersId

显示用户

参数

名称	密钥	必需	类型	说明
Id	id	True	integer	用户 ID。

返回

名称	路径	类型	说明
id	id	integer	用户 ID
用户名	username	string	用户的用户名
admin_group_ids	admin_group_ids	array of integer	此用户是管理员的组 ID 列表
allowed_ips	allowed_ips	string	允许的 IP 列表（如果适用）。 换行符分隔
attachments_permission	attachments_permission	boolean	如果用户 true可以创建捆绑包（即共享链接）。 请改用捆绑包权限。
api_keys_count	api_keys_count	integer	与此用户关联的 API 密钥数
authenticate_until	authenticate_until	string	将停用用户的计划日期或时间
authentication_method	authentication_method	string	此用户是如何进行身份验证的？
avatar_url	avatar_url	string	保存用户的头像的 URL
计费	billable	boolean	这是计费用户记录吗？
billing_permission	billing_permission	boolean	允许用户对帐户、付款和发票执行作？
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	允许此用户跳过站点范围的 IP 黑名单？
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	从用户生命周期规则中免除此用户？
创建时间	created_at	string	创建此用户时
dav_permission	dav_permission	boolean	用户是否可以使用 WebDAV 进行连接？
禁用的	disabled	boolean	用户是否已禁用？ 禁用的用户无法登录，并且不计入计费目的。 用户可以通过站点设置或在特定日期后停用的非活动期后自动禁用。
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	如果用户禁用或过期或处于非活动状态，则返回 true 的计算属性。
电子邮件	email	string	用户电子邮件地址
filesystem_layout	filesystem_layout	string	文件系统布局
first_login_at	first_login_at	string	用户的首次登录时间
ftp_permission	ftp_permission	boolean	用户是否可以使用 FTP 或 FTPS 进行访问？
group_ids	group_ids	string	此用户所属的组 ID 的逗号分隔列表
header_text	header_text	string	要向用户显示 UI 标头中的文本
语言	language	string	首选语言
last_login_at	last_login_at	string	用户最近通过任何协议登录时间
last_web_login_at	last_web_login_at	string	用户最近通过 Web 登录时间
last_ftp_login_at	last_ftp_login_at	string	用户最近通过 FTP 登录时间
last_sftp_login_at	last_sftp_login_at	string	用户最近通过 SFTP 登录时间
last_dav_login_at	last_dav_login_at	string	用户最近通过 WebDAV 登录时间
last_desktop_login_at	last_desktop_login_at	string	用户最近通过桌面应用登录时间
last_restapi_login_at	last_restapi_login_at	string	用户最近通过 Rest API 登录时间
last_api_use_at	last_api_use_at	string	用户的最新 API 使用时间
最后活动时间	last_active_at	string	用户最近的活动时间，这是最新登录、最新 API 使用、启用或创建
last_protocol_cipher	last_protocol_cipher	string	使用的最新协议和密码
lockout_expires	lockout_expires	string	将来用户不再被锁定的时间（如果适用）
姓名	name	string	用户的全名
company	company	string	用户的公司
笔记	notes	string	用户的任何内部说明
notification_daily_send_time	notification_daily_send_time	integer	每日通知应发送到的一天中的一小时。 范围为 0 到 23
office_integration_enabled	office_integration_enabled	boolean	启用与 Office 网页版的集成？
partner_admin	partner_admin	boolean	此用户是否为合作伙伴管理员？
partner_id	partner_id	integer	如果此用户属于合作伙伴，则合作伙伴 ID
partner_name	partner_name	string	如果此用户属于合作伙伴，则合作伙伴的名称
password_set_at	password_set_at	string	上次设置用户密码的时间
password_validity_days	password_validity_days	integer	允许用户使用相同的密码的天数
public_keys_count	public_keys_count	integer	与此用户关联的公钥数
receive_admin_alerts	receive_admin_alerts	boolean	用户是否应收到管理员警报，例如证书过期通知和超额？
require_2fa	require_2fa	string	2FA 所需设置
require_login_by	require_login_by	string	要求用户按指定日期登录，否则将被禁用。
active_2fa	active_2fa	boolean	2fa 是否对用户处于活动状态？
require_password_change	require_password_change	boolean	下次用户登录时是否需要更改密码？
password_expired	password_expired	boolean	用户的密码是否已过期？
readonly_site_admin	readonly_site_admin	boolean	是否允许用户查看此站点的所有（非计费）站点配置？
restapi_permission	restapi_permission	boolean	此用户是否可以访问 Web 应用、桌面应用、SDK 或 REST API？ （所有这些工具都在内部使用 API，因此这是一个统一的权限集。
self_managed	self_managed	boolean	此用户是否管理自己的凭据，或者是共享用户还是机器人用户？
sftp_permission	sftp_permission	boolean	用户是否可以使用 SFTP 进行访问？
site_admin	site_admin	boolean	用户是否是此网站的管理员？
site_id	site_id	integer	站点标识符
skip_welcome_screen	skip_welcome_screen	boolean	跳过 UI 中的欢迎页面？
ssl_required	ssl_required	string	SSL 所需设置
sso_strategy_id	sso_strategy_id	integer	用户的 SSO（单一登录）策略 ID（如果适用）。
subscribe_to_newsletter	subscribe_to_newsletter	boolean	用户是否订阅了新闻稿？
externally_managed	externally_managed	boolean	此用户是否由 SsoStrategy 管理？
tags	tags	string	此用户的标记的逗号分隔列表。 标记用于其他功能，例如 UserLifecycleRules，这些功能可面向特定标记。 标记只能包含小写字母、数字和连字符。
时区	time_zone	string	用户时区
type_of_2fa	type_of_2fa	string	正在使用的 2FA 方法的类型（s），以便以编程方式使用。 将按sms字母顺序排序并按下划线联接的多个值、 totpwebauthnyubiemail、、或多个值。 不指定用户是否具有多个给定方法。
type_of_2fa_for_display	type_of_2fa_for_display	string	正在使用的 2FA 方法的类型（s），格式用于在 UI 中显示。 与不同的是 type_of_2fa，当用户具有相同类型方法的 1 个以上时，此值将明确。
user_root	user_root	string	FTP 的根文件夹（如果设置了适当的站点范围设置，则为 SFTP）。 请注意，这不用于 API、桌面或 Web 界面。
user_home	user_home	string	FTP 或 SFTP 的主文件夹。 请注意，这不用于 API、桌面或 Web 界面。
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	密码过期之前的天数
password_expire_at	password_expire_at	string	密码过期日期/时间

显示组

操作 ID:

GetGroupsId

显示组

参数

名称	密钥	必需	类型	说明
Id	id	True	integer	组 ID。

返回

名称	路径	类型	说明
id	id	integer	群组标识符
姓名	name	string	组名称
allowed_ips	allowed_ips	string	允许的 IP 列表（如果适用）。 换行符分隔
admin_ids	admin_ids	string	以逗号分隔的用户 ID 列表（用逗号分隔）
笔记	notes	string	有关此组的说明
user_ids	user_ids	string	属于此组的用户 ID 的逗号分隔列表（用逗号分隔）
usernames	usernames	string	属于此组的用户名的逗号分隔列表（用逗号分隔）
ftp_permission	ftp_permission	boolean	如果为 true，则此组中的用户可以使用 FTP 登录。 这将替代用户级别的 false 值 ftp_permission 。
sftp_permission	sftp_permission	boolean	如果为 true，则此组中的用户可以使用 SFTP 登录。 这将替代用户级别的 false 值 sftp_permission 。
dav_permission	dav_permission	boolean	如果为 true，则此组中的用户可以使用 WebDAV 登录。 这将替代用户级别的 false 值 dav_permission 。
restapi_permission	restapi_permission	boolean	如果为 true，则此组中的用户可以使用 REST API 登录。 这将替代用户级别的 false 值 restapi_permission 。
site_id	site_id	integer	站点标识符

更新共享链接

操作 ID:

PatchBundlesId

更新共享链接

参数

名称	密钥	必需	类型	说明
Id	id	True	integer	捆绑 ID。
到期时间	expires_at		date-time	捆绑过期日期/时间

返回

名称	路径	类型	说明
代码	code	string	捆绑代码。 此代码构成了公共 URL 的结束部分。
color_left	color_left	string	页面链接和按钮颜色
color_link	color_link	string	顶部栏链接颜色
color_text	color_text	string	页面链接和按钮颜色
color_top	color_top	string	上栏背景色
color_top_text	color_top_text	string	顶部条形图文本颜色
网址	url	string	共享链接的公共 URL
描述	description	string	公共说明
过期时间	expires_at	string	捆绑过期日期或时间
password_protected	password_protected	boolean	此捆绑包密码是否受保护？
权限	permissions	string	应用于此共享链接中的文件夹的权限。
preview_only	preview_only	boolean
require_registration	require_registration	boolean	显示捕获下载程序名称和电子邮件地址的注册页？
require_share_recipient	require_share_recipient	boolean	仅允许通过 Files.com UI 发送的电子邮件显式接收共享的收件人的访问权限？
require_logout	require_logout	boolean	如果为 true，我们将隐藏捆绑包注册页上的“记住我”框，要求用户每次访问页面时注销并重新登录。
clickwrap_body	clickwrap_body	string	在访问捆绑包之前必须同意的法律文本。
id	form_field_set.id	integer	窗体域集 ID
title	form_field_set.title	string	要显示的标题
form_layout	form_field_set.form_layout	array of integer	窗体的布局
form_fields	form_field_set.form_fields	array of object	关联的表单字段
items	form_field_set.form_fields	object
skip_name	form_field_set.skip_name	boolean	无需提供名称即可保存任何关联的 InboxRegistrations 或 BundleRegistrations
skip_email	form_field_set.skip_email	boolean	无需提供电子邮件即可保存任何关联的 InboxRegistrations 或 BundleRegistrations
skip_company	form_field_set.skip_company	boolean	无需提供公司即可保存任何关联的 InboxRegistrations 或 BundleRegistrations
in_use	form_field_set.in_use	boolean	表单字段集由活动收件箱、捆绑包或收件箱注册或捆绑包注册使用
skip_name	skip_name	boolean	可以保存 BundleRegistrations 而不提供名称？
skip_email	skip_email	boolean	可以保存 BundleRegistrations 而不提供电子邮件？
start_access_on_date	start_access_on_date	string	共享开始可访问的日期。 如果在 nil 创建后授予访问权限。
skip_company	skip_company	boolean	可以在不提供公司的情况下保存 BundleRegistration？
id	id	integer	捆绑销售 ID
创建时间	created_at	string	在日期或时间创建的捆绑包
dont_separate_submissions_by_folder	dont_separate_submissions_by_folder	boolean	不要为上传到此共享的文件创建子文件夹。 注意：存在一些细微的安全陷阱，允许多个用户的匿名上传位于同一文件夹中。 除非绝对需要，否则我们强烈建议不要使用此选项。
max_uses	max_uses	integer	可以访问捆绑包的最大次数
注意	note	string	捆绑内部说明
path_template	path_template	string	用于创建提交子文件夹的模板。 可以使用上传程序的名称、电子邮件地址、ip、公司、 strftime 指令和任何自定义表单数据。
path_template_time_zone	path_template_time_zone	string	在路径模板中呈现时间戳时要使用的时区。
send_email_receipt_to_uploader	send_email_receipt_to_uploader	boolean	将送达回执发送到上传程序。 注意：仅适用于可写共享
snapshot_id	snapshot_id	integer	包含此捆绑包内容的快照的 ID。
用户ID	user_id	integer	捆绑创建者用户 ID
用户名	username	string	捆绑创建者用户名
clickwrap_id	clickwrap_id	integer	要用于此捆绑包的 clickwrap 的 ID。
inbox_id	inbox_id	integer	关联的收件箱的 ID（如果可用）。
姓名	watermark_attachment.name	string	映像名称
uri	watermark_attachment.uri	string	映像 URI
watermark_value	watermark_value	object	应用于所有捆绑项的预览水印设置。 使用与 Behavior.value 相同的键
has_inbox	has_inbox	boolean	此捆绑包是否具有关联的收件箱？
dont_allow_folders_in_uploads	dont_allow_folders_in_uploads	boolean	是否应阻止文件夹上传？
路径	paths	array of string	此捆绑包中的路径列表。 出于性能原因，列出捆绑包时不提供此功能。
bundlepaths	bundlepaths	array of object	此捆绑包中的捆绑路径列表。 出于性能原因，列出捆绑包时不提供此功能。
items	bundlepaths	object

更新共享链接通知

操作 ID:

PatchBundleNotificationsId

更新共享链接通知

参数

名称	密钥	必需	类型	说明
Id	id	True	integer	捆绑通知 ID。
在注册时通知	notify_on_registration		boolean	在注册作发生时触发捆绑通知。
上传时通知	notify_on_upload		boolean	在上传作发生时触发捆绑通知。

返回

名称	路径	类型	说明
bundle_id	bundle_id	integer	要通知的捆绑 ID
id	id	integer	捆绑通知 ID
notify_on_registration	notify_on_registration	boolean	在注册作发生时触发捆绑通知。
notify_on_upload	notify_on_upload	boolean	在上传作发生时触发捆绑通知。
notify_user_id	notify_user_id	integer	要通知的用户的 ID。

更新用户

操作 ID:

PatchUsersId

更新用户

参数

名称	密钥	必需	类型	说明
Id	id	True	integer	用户 ID。
身份验证方法	authentication_method		string	此用户是如何进行身份验证的？
公司	company		string	用户的公司
Email	email		string	用户的电子邮件。
组 ID	group_ids		string	要与此用户关联的组 ID 列表。 逗号分隔。
Name	name		string	用户的全名
注释	notes		string	用户的任何内部说明
密码	password		string	用户密码。
要求更改密码	require_password_change		boolean	下次用户登录时是否需要更改密码？
用户主页	user_home		string	FTP/SFTP 的主文件夹。 请注意，这不用于 API、桌面或 Web 界面。
用户根	user_root		string	FTP 的根文件夹（如果设置了适当的站点范围设置，则为 SFTP）。 请注意，这不用于 API、桌面或 Web 界面。
用户名	username		string	用户的用户名

返回

名称	路径	类型	说明
id	id	integer	用户 ID
用户名	username	string	用户的用户名
admin_group_ids	admin_group_ids	array of integer	此用户是管理员的组 ID 列表
allowed_ips	allowed_ips	string	允许的 IP 列表（如果适用）。 换行符分隔
attachments_permission	attachments_permission	boolean	如果用户 true可以创建捆绑包（即共享链接）。 请改用捆绑包权限。
api_keys_count	api_keys_count	integer	与此用户关联的 API 密钥数
authenticate_until	authenticate_until	string	将停用用户的计划日期或时间
authentication_method	authentication_method	string	此用户是如何进行身份验证的？
avatar_url	avatar_url	string	保存用户的头像的 URL
计费	billable	boolean	这是计费用户记录吗？
billing_permission	billing_permission	boolean	允许用户对帐户、付款和发票执行作？
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	允许此用户跳过站点范围的 IP 黑名单？
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	从用户生命周期规则中免除此用户？
创建时间	created_at	string	创建此用户时
dav_permission	dav_permission	boolean	用户是否可以使用 WebDAV 进行连接？
禁用的	disabled	boolean	用户是否已禁用？ 禁用的用户无法登录，并且不计入计费目的。 用户可以通过站点设置或在特定日期后停用的非活动期后自动禁用。
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	如果用户禁用或过期或处于非活动状态，则返回 true 的计算属性。
电子邮件	email	string	用户电子邮件地址
filesystem_layout	filesystem_layout	string	文件系统布局
first_login_at	first_login_at	string	用户的首次登录时间
ftp_permission	ftp_permission	boolean	用户是否可以使用 FTP 或 FTPS 进行访问？
group_ids	group_ids	string	此用户所属的组 ID 的逗号分隔列表
header_text	header_text	string	要向用户显示 UI 标头中的文本
语言	language	string	首选语言
last_login_at	last_login_at	string	用户最近通过任何协议登录时间
last_web_login_at	last_web_login_at	string	用户最近通过 Web 登录时间
last_ftp_login_at	last_ftp_login_at	string	用户最近通过 FTP 登录时间
last_sftp_login_at	last_sftp_login_at	string	用户最近通过 SFTP 登录时间
last_dav_login_at	last_dav_login_at	string	用户最近通过 WebDAV 登录时间
last_desktop_login_at	last_desktop_login_at	string	用户最近通过桌面应用登录时间
last_restapi_login_at	last_restapi_login_at	string	用户最近通过 Rest API 登录时间
last_api_use_at	last_api_use_at	string	用户的最新 API 使用时间
最后活动时间	last_active_at	string	用户最近的活动时间，这是最新登录、最新 API 使用、启用或创建
last_protocol_cipher	last_protocol_cipher	string	使用的最新协议和密码
lockout_expires	lockout_expires	string	将来用户不再被锁定的时间（如果适用）
姓名	name	string	用户的全名
company	company	string	用户的公司
笔记	notes	string	用户的任何内部说明
notification_daily_send_time	notification_daily_send_time	integer	每日通知应发送到的一天中的一小时。 范围为 0 到 23
office_integration_enabled	office_integration_enabled	boolean	启用与 Office 网页版的集成？
partner_admin	partner_admin	boolean	此用户是否为合作伙伴管理员？
partner_id	partner_id	integer	如果此用户属于合作伙伴，则合作伙伴 ID
partner_name	partner_name	string	如果此用户属于合作伙伴，则合作伙伴的名称
password_set_at	password_set_at	string	上次设置用户密码的时间
password_validity_days	password_validity_days	integer	允许用户使用相同的密码的天数
public_keys_count	public_keys_count	integer	与此用户关联的公钥数
receive_admin_alerts	receive_admin_alerts	boolean	用户是否应收到管理员警报，例如证书过期通知和超额？
require_2fa	require_2fa	string	2FA 所需设置
require_login_by	require_login_by	string	要求用户按指定日期登录，否则将被禁用。
active_2fa	active_2fa	boolean	2fa 是否对用户处于活动状态？
require_password_change	require_password_change	boolean	下次用户登录时是否需要更改密码？
password_expired	password_expired	boolean	用户的密码是否已过期？
readonly_site_admin	readonly_site_admin	boolean	是否允许用户查看此站点的所有（非计费）站点配置？
restapi_permission	restapi_permission	boolean	此用户是否可以访问 Web 应用、桌面应用、SDK 或 REST API？ （所有这些工具都在内部使用 API，因此这是一个统一的权限集。
self_managed	self_managed	boolean	此用户是否管理自己的凭据，或者是共享用户还是机器人用户？
sftp_permission	sftp_permission	boolean	用户是否可以使用 SFTP 进行访问？
site_admin	site_admin	boolean	用户是否是此网站的管理员？
site_id	site_id	integer	站点标识符
skip_welcome_screen	skip_welcome_screen	boolean	跳过 UI 中的欢迎页面？
ssl_required	ssl_required	string	SSL 所需设置
sso_strategy_id	sso_strategy_id	integer	用户的 SSO（单一登录）策略 ID（如果适用）。
subscribe_to_newsletter	subscribe_to_newsletter	boolean	用户是否订阅了新闻稿？
externally_managed	externally_managed	boolean	此用户是否由 SsoStrategy 管理？
tags	tags	string	此用户的标记的逗号分隔列表。 标记用于其他功能，例如 UserLifecycleRules，这些功能可面向特定标记。 标记只能包含小写字母、数字和连字符。
时区	time_zone	string	用户时区
type_of_2fa	type_of_2fa	string	正在使用的 2FA 方法的类型（s），以便以编程方式使用。 将按sms字母顺序排序并按下划线联接的多个值、 totpwebauthnyubiemail、、或多个值。 不指定用户是否具有多个给定方法。
type_of_2fa_for_display	type_of_2fa_for_display	string	正在使用的 2FA 方法的类型（s），格式用于在 UI 中显示。 与不同的是 type_of_2fa，当用户具有相同类型方法的 1 个以上时，此值将明确。
user_root	user_root	string	FTP 的根文件夹（如果设置了适当的站点范围设置，则为 SFTP）。 请注意，这不用于 API、桌面或 Web 界面。
user_home	user_home	string	FTP 或 SFTP 的主文件夹。 请注意，这不用于 API、桌面或 Web 界面。
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	密码过期之前的天数
password_expire_at	password_expire_at	string	密码过期日期/时间

更新用户

操作 ID:

PatchUser

更新用户

参数

名称	密钥	必需	类型	说明
身份验证方法	authentication_method		string	此用户是如何进行身份验证的？
公司	company		string	用户的公司
Email	email		string	用户的电子邮件。
组 ID	group_ids		string	要与此用户关联的组 ID 列表。 逗号分隔。
Name	name		string	用户的全名
注释	notes		string	用户的任何内部说明
密码	password		string	用户密码。
要求更改密码	require_password_change		boolean	下次用户登录时是否需要更改密码？
用户主页	user_home		string	FTP/SFTP 的主文件夹。 请注意，这不用于 API、桌面或 Web 界面。
用户根	user_root		string	FTP 的根文件夹（如果设置了适当的站点范围设置，则为 SFTP）。 请注意，这不用于 API、桌面或 Web 界面。
用户名	username		string	用户的用户名

返回

名称	路径	类型	说明
id	id	integer	用户 ID
用户名	username	string	用户的用户名
admin_group_ids	admin_group_ids	array of integer	此用户是管理员的组 ID 列表
allowed_ips	allowed_ips	string	允许的 IP 列表（如果适用）。 换行符分隔
attachments_permission	attachments_permission	boolean	如果用户 true可以创建捆绑包（即共享链接）。 请改用捆绑包权限。
api_keys_count	api_keys_count	integer	与此用户关联的 API 密钥数
authenticate_until	authenticate_until	string	将停用用户的计划日期或时间
authentication_method	authentication_method	string	此用户是如何进行身份验证的？
avatar_url	avatar_url	string	保存用户的头像的 URL
计费	billable	boolean	这是计费用户记录吗？
billing_permission	billing_permission	boolean	允许用户对帐户、付款和发票执行作？
bypass_site_allowed_ips	bypass_site_allowed_ips	boolean	允许此用户跳过站点范围的 IP 黑名单？
bypass_user_lifecycle_rules	bypass_user_lifecycle_rules	boolean	从用户生命周期规则中免除此用户？
创建时间	created_at	string	创建此用户时
dav_permission	dav_permission	boolean	用户是否可以使用 WebDAV 进行连接？
禁用的	disabled	boolean	用户是否已禁用？ 禁用的用户无法登录，并且不计入计费目的。 用户可以通过站点设置或在特定日期后停用的非活动期后自动禁用。
disabled_expired_or_inactive	disabled_expired_or_inactive	boolean	如果用户禁用或过期或处于非活动状态，则返回 true 的计算属性。
电子邮件	email	string	用户电子邮件地址
filesystem_layout	filesystem_layout	string	文件系统布局
first_login_at	first_login_at	string	用户的首次登录时间
ftp_permission	ftp_permission	boolean	用户是否可以使用 FTP 或 FTPS 进行访问？
group_ids	group_ids	string	此用户所属的组 ID 的逗号分隔列表
header_text	header_text	string	要向用户显示 UI 标头中的文本
语言	language	string	首选语言
last_login_at	last_login_at	string	用户最近通过任何协议登录时间
last_web_login_at	last_web_login_at	string	用户最近通过 Web 登录时间
last_ftp_login_at	last_ftp_login_at	string	用户最近通过 FTP 登录时间
last_sftp_login_at	last_sftp_login_at	string	用户最近通过 SFTP 登录时间
last_dav_login_at	last_dav_login_at	string	用户最近通过 WebDAV 登录时间
last_desktop_login_at	last_desktop_login_at	string	用户最近通过桌面应用登录时间
last_restapi_login_at	last_restapi_login_at	string	用户最近通过 Rest API 登录时间
last_api_use_at	last_api_use_at	string	用户的最新 API 使用时间
最后活动时间	last_active_at	string	用户最近的活动时间，这是最新登录、最新 API 使用、启用或创建
last_protocol_cipher	last_protocol_cipher	string	使用的最新协议和密码
lockout_expires	lockout_expires	string	将来用户不再被锁定的时间（如果适用）
姓名	name	string	用户的全名
company	company	string	用户的公司
笔记	notes	string	用户的任何内部说明
notification_daily_send_time	notification_daily_send_time	integer	每日通知应发送到的一天中的一小时。 范围为 0 到 23
office_integration_enabled	office_integration_enabled	boolean	启用与 Office 网页版的集成？
partner_admin	partner_admin	boolean	此用户是否为合作伙伴管理员？
partner_id	partner_id	integer	如果此用户属于合作伙伴，则合作伙伴 ID
partner_name	partner_name	string	如果此用户属于合作伙伴，则合作伙伴的名称
password_set_at	password_set_at	string	上次设置用户密码的时间
password_validity_days	password_validity_days	integer	允许用户使用相同的密码的天数
public_keys_count	public_keys_count	integer	与此用户关联的公钥数
receive_admin_alerts	receive_admin_alerts	boolean	用户是否应收到管理员警报，例如证书过期通知和超额？
require_2fa	require_2fa	string	2FA 所需设置
require_login_by	require_login_by	string	要求用户按指定日期登录，否则将被禁用。
active_2fa	active_2fa	boolean	2fa 是否对用户处于活动状态？
require_password_change	require_password_change	boolean	下次用户登录时是否需要更改密码？
password_expired	password_expired	boolean	用户的密码是否已过期？
readonly_site_admin	readonly_site_admin	boolean	是否允许用户查看此站点的所有（非计费）站点配置？
restapi_permission	restapi_permission	boolean	此用户是否可以访问 Web 应用、桌面应用、SDK 或 REST API？ （所有这些工具都在内部使用 API，因此这是一个统一的权限集。
self_managed	self_managed	boolean	此用户是否管理自己的凭据，或者是共享用户还是机器人用户？
sftp_permission	sftp_permission	boolean	用户是否可以使用 SFTP 进行访问？
site_admin	site_admin	boolean	用户是否是此网站的管理员？
site_id	site_id	integer	站点标识符
skip_welcome_screen	skip_welcome_screen	boolean	跳过 UI 中的欢迎页面？
ssl_required	ssl_required	string	SSL 所需设置
sso_strategy_id	sso_strategy_id	integer	用户的 SSO（单一登录）策略 ID（如果适用）。
subscribe_to_newsletter	subscribe_to_newsletter	boolean	用户是否订阅了新闻稿？
externally_managed	externally_managed	boolean	此用户是否由 SsoStrategy 管理？
tags	tags	string	此用户的标记的逗号分隔列表。 标记用于其他功能，例如 UserLifecycleRules，这些功能可面向特定标记。 标记只能包含小写字母、数字和连字符。
时区	time_zone	string	用户时区
type_of_2fa	type_of_2fa	string	正在使用的 2FA 方法的类型（s），以便以编程方式使用。 将按sms字母顺序排序并按下划线联接的多个值、 totpwebauthnyubiemail、、或多个值。 不指定用户是否具有多个给定方法。
type_of_2fa_for_display	type_of_2fa_for_display	string	正在使用的 2FA 方法的类型（s），格式用于在 UI 中显示。 与不同的是 type_of_2fa，当用户具有相同类型方法的 1 个以上时，此值将明确。
user_root	user_root	string	FTP 的根文件夹（如果设置了适当的站点范围设置，则为 SFTP）。 请注意，这不用于 API、桌面或 Web 界面。
user_home	user_home	string	FTP 或 SFTP 的主文件夹。 请注意，这不用于 API、桌面或 Web 界面。
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	密码过期之前的天数
password_expire_at	password_expire_at	string	密码过期日期/时间

更新组

操作 ID:

PatchGroupsId

更新组

参数

名称	密钥	必需	类型	说明
Id	id	True	integer	组 ID。
管理员 ID	admin_ids		string	组管理员用户 ID 的列表。 如果以字符串的形式发送，应以逗号分隔。
Name	name		string	组名称。
注释	notes		string	组备注。
用户 ID	user_ids		string	用户 ID 的列表。 如果以字符串的形式发送，应以逗号分隔。

返回

名称	路径	类型	说明
id	id	integer	群组标识符
姓名	name	string	组名称
allowed_ips	allowed_ips	string	允许的 IP 列表（如果适用）。 换行符分隔
admin_ids	admin_ids	string	以逗号分隔的用户 ID 列表（用逗号分隔）
笔记	notes	string	有关此组的说明
user_ids	user_ids	string	属于此组的用户 ID 的逗号分隔列表（用逗号分隔）
usernames	usernames	string	属于此组的用户名的逗号分隔列表（用逗号分隔）
ftp_permission	ftp_permission	boolean	如果为 true，则此组中的用户可以使用 FTP 登录。 这将替代用户级别的 false 值 ftp_permission 。
sftp_permission	sftp_permission	boolean	如果为 true，则此组中的用户可以使用 SFTP 登录。 这将替代用户级别的 false 值 sftp_permission 。
dav_permission	dav_permission	boolean	如果为 true，则此组中的用户可以使用 WebDAV 登录。 这将替代用户级别的 false 值 dav_permission 。
restapi_permission	restapi_permission	boolean	如果为 true，则此组中的用户可以使用 REST API 登录。 这将替代用户级别的 false 值 restapi_permission 。
site_id	site_id	integer	站点标识符

移动文件或文件夹

操作 ID:

FileActionMove

移动文件或文件夹

参数

名称	密钥	必需	类型	说明
路径	path	True	string	要作的路径。
目的地	destination	True	string	移动目标路径。

返回

名称	路径	类型	说明
状态	status	string	文件作的状态。
file_migration_id	file_migration_id	integer	如果状态处于挂起状态，则这是文件迁移的 ID，用于检查状态更新。