Files.com（預覽）

Files.com 連接器提供直接且高效能的整合，支援 Files.com 自動化工作流程與跨Microsoft自動化平台的整合。

此連接器適用於以下產品和區域：

服務	Class	Regions
副駕駛工作室	進階	除下列區域外的所有 Power Automate 區域 ：      - 美國政府 （GCC）      - 美國政府（海灣合作委員會高中）      - 由 21Vianet 營運的中國雲      - 美國國防部 （DoD）
邏輯應用程式	標準	所有 Logic Apps 區域， 但下列區域除外：      - Azure Government 區域      - Azure 中國區域      - 美國國防部 （DoD）
Power Apps	進階	除下列區域外的所有 Power Apps 區域 ：      - 美國政府 （GCC）      - 美國政府（海灣合作委員會高中）      - 由 21Vianet 營運的中國雲      - 美國國防部 （DoD）
Power Automate（自動化服務）	進階	除下列區域外的所有 Power Automate 區域 ：      - 美國政府 （GCC）      - 美國政府（海灣合作委員會高中）      - 由 21Vianet 營運的中國雲      - 美國國防部 （DoD）

連絡人​​
名稱	Files.com 支援
URL	https://www.files.com/contact
Email	support@files.com

連接器中繼資料
Publisher	Files.com
網站	https://www.files.com/
隱私策略	https://www.files.com/legal/privacy
類別	內容與檔案;資訊科技作業

Files.com Power Automate 連接器

概觀

Files.com 連接器提供直接且高效能的整合，Files.com Microsoft Power Automate 與 Azure Logic Apps。 Files.com 是雲端原生的次世代 MFT、SFTP 和安全檔案分享平台，取代脆弱的舊有伺服器，採用一個始終連線且安全的網路架構。 自動化關鍵任務的檔案流程——跨越任何雲端、協定或合作夥伴——同時支援人工協作，免除人工作業。

注意：此連接器僅提供動作，尚未包含觸發器。

⸻

先決條件

使用此連接器前，請確保您擁有：1. 有效的 Files.com 帳號及 API 金鑰。 2. 存取 Microsoft Power Automate。

⸻

Authentication

此連接器使用 API 金鑰認證。 您的 API 金鑰可在您的 Files.com 帳戶中依以下方式產生：

設定→ API 金鑰→建立 API 金鑰。

在設定連接器時，請在認證欄位輸入你的 Files.com 主機和 API 金鑰。

範例：

主機：yourcompany API Key：abc123456789...

所有申請均送達：

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

⸻

範例使用案例 1.管理使用者與群組 建立、更新或停用使用者、指派角色，並直接透過 Power Automate 操作管理群組成員資格。 2. 自動化分享連結（組合）工作流程 產生檔案傳遞分享連結、新增收件人、設定通知或自動撤銷存取權。 3. 同步檔案元資料、清單資料夾、擷取檔案元資料，並套用自動化邏輯，如權限變更或標籤。 4. 建立使用者配置工作流程：將人力資源或身份管理系統與 Files.com 整合，以在變更發生時自動建立使用者或更新存取權限。 5. 觸發文件分發 將 Files.com 動作與 OneDrive 或 SharePoint 結合，以安全分發或封存文件。

⸻

Support

如需技術協助或連接器設定問題，請聯絡 Files.com 客服 https://www.files.com/contact

關於 Power Automate 專屬的問題，請參閱 Microsoft 的自訂連接器文件。

⸻

法律注意事項

此連接器由 Files.com 提供。 使用此連接器即表示您同意 Files.com 服務條款及隱私政策。

正在建立連線

連接器支援下列驗證類型：

預設值	建立連線的參數。	所有區域	不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱	類型	Description	為必填項目
API 密鑰 (api_key)	安全字串	此 API 的api_key	對

節流限制

名稱	呼叫	續約期間
每個連線的 API 呼叫	100	60 秒

動作

上傳檔案	上傳檔案
下載檔案	下載檔案
依路徑尋找檔案或資料夾	依路徑尋找檔案或資料夾
依路徑排列的資料夾列表	依路徑排列的資料夾列表
列出使用者	列出使用者
列表 分享 連結 下載	列表 分享 連結 下載
列表 分享 連結 收件人	列表 分享 連結 收件人
列表 分享 連結 註冊	列表 分享 連結 註冊
列表分享連結	列表分享連結
列表分享連結通知	列表分享連結通知
刪除 分享連結	刪除 分享連結
刪除 分享連結通知	刪除 分享連結通知
刪除使用者	刪除使用者
刪除檔案或資料夾	刪除檔案或資料夾
刪除群組	刪除群組
建立 分享 連結	建立 分享 連結
建立 分享 連結收件人	建立 分享 連結收件人
建立使用者	建立使用者
建立分享連結通知	建立分享連結通知
建立群組	建立群組
建立資料夾	建立資料夾
更新 分享連結	更新 分享連結
更新 分享連結通知	更新 分享連結通知
更新使用者	更新使用者
更新使用者	更新使用者
更新群組	更新群組
清單組	清單組
為群組建立一個新的使用者帳號	為群組建立一個新的使用者帳號
移動檔案或資料夾	移動檔案或資料夾
節目使用者	節目使用者
節目組	節目組
複製檔案或資料夾	複製檔案或資料夾
顯示 分享連結	顯示 分享連結
顯示 分享連結通知	顯示 分享連結通知

上傳檔案

作業識別碼：

UploadFile

上傳檔案

參數

名稱	機碼	必要	類型	Description
路徑	path	True	string	手術路徑。
檔案內容	body	True	binary	檔案內容要上傳。 傳送你想儲存在 Files.com 的精確位元組。

下載檔案

作業識別碼：

DownloadFile

下載檔案

參數

名稱	機碼	必要	類型	Description
路徑	path	True	string	手術路徑。

傳回

檔案內容

binary

依路徑尋找檔案或資料夾

作業識別碼：

FileActionFind

依路徑尋找檔案或資料夾

參數

名稱	機碼	必要	類型	Description
路徑	path	True	string	手術路徑。

傳回

名稱	路徑	類型	Description
路徑	path	string	檔案或資料夾路徑。 這必須以斜線分隔，但不能以斜線開頭或結尾。 最多5000字元。
created_by_id	created_by_id	integer	建立該檔案或資料夾的使用者 ID
created_by_api_key_id	created_by_api_key_id	integer	建立檔案或資料夾的 API 金鑰的識別碼
created_by_as2_incoming_message_id	created_by_as2_incoming_message_id	integer	建立該檔案或資料夾的 AS2 入信的識別碼
created_by_automation_id	created_by_automation_id	integer	建立該檔案或資料夾的自動化識別碼
created_by_bundle_registration_id	created_by_bundle_registration_id	integer	建立該檔案或資料夾的 Bundle 註冊的 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_sync_id	created_by_sync_id	integer	建立該檔案或資料夾的同步識別碼
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	最後修改該檔案或資料夾的自動化識別碼
last_modified_by_bundle_registration_id	last_modified_by_bundle_registration_id	integer	最後修改該檔案或資料夾的 Bundle 註冊的 ID
last_modified_by_remote_server_id	last_modified_by_remote_server_id	integer	最後修改該檔案或資料夾的遠端伺服器識別碼
last_modified_by_sync_id	last_modified_by_sync_id	integer	最後修改該檔案或資料夾的同步識別碼
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類型	mime_type	string	啞劇類型。 這是由檔案副檔名決定，內部不會單獨儲存。
區域	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
識別碼	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	預覽尺寸

依路徑排列的資料夾列表

作業識別碼：

FolderListForPath

依路徑排列的資料夾列表

參數

名稱	機碼	必要	類型	Description
路徑	path	True	string	手術路徑。

傳回

名稱	路徑	類型	Description
		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 金鑰的識別碼
created_by_as2_incoming_message_id	created_by_as2_incoming_message_id	integer	建立該檔案或資料夾的 AS2 入信的識別碼
created_by_automation_id	created_by_automation_id	integer	建立該檔案或資料夾的自動化識別碼
created_by_bundle_registration_id	created_by_bundle_registration_id	integer	建立該檔案或資料夾的 Bundle 註冊的 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_sync_id	created_by_sync_id	integer	建立該檔案或資料夾的同步識別碼
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	最後修改該檔案或資料夾的自動化識別碼
last_modified_by_bundle_registration_id	last_modified_by_bundle_registration_id	integer	最後修改該檔案或資料夾的 Bundle 註冊的 ID
last_modified_by_remote_server_id	last_modified_by_remote_server_id	integer	最後修改該檔案或資料夾的遠端伺服器識別碼
last_modified_by_sync_id	last_modified_by_sync_id	integer	最後修改該檔案或資料夾的同步識別碼
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類型	mime_type	string	啞劇類型。 這是由檔案副檔名決定，內部不會單獨儲存。
區域	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
識別碼	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	預覽尺寸

列出使用者

作業識別碼：

GetUsers

列出使用者

傳回

名稱	路徑	類型	Description
		array of object
識別碼	id	integer	使用者識別碼
使用者名稱	username	string	使用者用戶名
admin_group_ids	admin_group_ids	array of integer	此使用者為管理員的群組 ID 列表
allowed_ips	allowed_ips	string	如果適用，請提供允許的 IP 清單。 Newline 界定
attachments_permission	attachments_permission	boolean	如果 true，使用者可以建立組合包（又稱分享連結）。 改用 bundle 權限吧。
api_keys_count	api_keys_count	integer	與此使用者關聯的 API 金鑰數量
authenticate_until	authenticate_until	string	預定的停用日期或時間
authentication_method	authentication_method	string	這個使用者是如何被認證的？
avatar_url	avatar_url	string	網址中儲存使用者頭像
可計費	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	計算屬性，若使用者停用、過期或非啟用，則會回傳為真。
電子郵件	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	使用者介面標頭中顯示的文字
語言	language	string	首選語言
last_login_at	last_login_at	string	使用者透過任何協定最近一次登入時間
last_web_login_at	last_web_login_at	string	使用者最近一次透過網頁登入的時間
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	last_active_at	string	使用者最近的活動時間，也就是最近一次登入、最近一次 API 使用、啟用或建立的時間
last_protocol_cipher	last_protocol_cipher	string	最新使用的協議與密碼
lockout_expires	lockout_expires	string	未來若適用，使用者將不再被鎖定
名稱	name	string	使用者的全名
公司	company	string	使用者公司
附註	notes	string	使用者的內部備註
notification_daily_send_time	notification_daily_send_time	integer	每天通知應該在哪個時段發送。 範圍可為0到23
office_integration_enabled	office_integration_enabled	boolean	啟用與 Office for the Web 的整合？
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	使用者的雙重驗證是否啟用？
require_password_change	require_password_change	boolean	下次使用者登入時是否需要更改密碼？
password_expired	password_expired	boolean	使用者的密碼過期了嗎？
readonly_site_admin	readonly_site_admin	boolean	使用者是否可以查看這個網站的所有（非計費）網站設定？
restapi_permission	restapi_permission	boolean	這個使用者能存取網頁應用程式、桌面應用程式、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	在介面中跳過歡迎頁面？
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	用於程式化用途的雙重驗證方法類型。 將以 sms、 totp、 webauthnyubiemail，或多個按字母順序排序並以底線連接的值。 未指定使用者是否擁有多於一種特定方法。
type_of_2fa_for_display	type_of_2fa_for_display	string	目前使用的雙重認證方法類型，格式化以便於使用者介面中顯示。 與 type_of_2fa不同，這個值會清楚顯示使用者是否擁有多個相同類型的方法。
user_root	user_root	string	FTP 的根目錄（如果設定了適當的全站設定，也可以選擇 SFTP）。 請注意，這不適用於 API、桌面或網頁介面。
user_home	user_home	string	FTP 或 SFTP 的 Home 資料夾。 請注意，這不適用於 API、桌面或網頁介面。
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	距離密碼到期還有多少天數
password_expire_at	password_expire_at	string	密碼到期日期時間

列表 分享 連結 下載

作業識別碼：

GetBundleDownloads

列表 分享 連結 下載

參數

名稱	機碼	必要	類型	Description
套件組合 ID	bundle_id		integer	套件組合識別碼

傳回

名稱	路徑	類型	Description
		array of object
字碼	bundle_registration.code	string	註冊 Cookie 代碼
名稱	bundle_registration.name	string	登記人姓名
公司	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	顯示給註冊人的點擊摺疊文字
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	相關組合接收者的身份
建立於	bundle_registration.created_at	string	註冊建立日期或時間
download_method	download_method	string	下載方法（檔案或full_zip）
路徑	path	string	下載路徑。 這必須以斜線分隔，但不能以斜線開頭或結尾。 最多5000字元。
建立於	created_at	string	下載日期或時間

列表 分享 連結 收件人

作業識別碼：

GetBundleRecipients

列表 分享 連結 收件人

參數

名稱	機碼	必要	類型	Description
套件組合 ID	bundle_id	True	integer	請以此 ID 列出該組合的收件人。

傳回

名稱	路徑	類型	Description
		array of object
公司	company	string	收件人的公司。
名稱	name	string	收件人的名字。
注意	note	string	一封隨包裹寄給收件人的便條。
收件者	recipient	string	收件者的電子郵件地址。
sent_at	sent_at	string	當包裹與這位收禮者共享時，

列表 分享 連結 註冊

作業識別碼：

GetBundleRegistrations

列表 分享 連結 註冊

參數

名稱	機碼	必要	類型	Description
套件組合 ID	bundle_id		integer	相關 Bundle 的識別碼

傳回

名稱	路徑	類型	Description
		array of object
字碼	code	string	註冊 Cookie 代碼
名稱	name	string	登記人姓名
公司	company	string	註冊公司名稱
電子郵件	email	string	登記人電子郵件地址
ip	ip	string	註冊人 IP 位址
inbox_code	inbox_code	string	InboxRegistration cookie 代碼，如果有相關的 InboxRegistration
clickwrap_body	clickwrap_body	string	顯示給註冊人的點擊摺疊文字
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	相關組合接收者的身份
建立於	created_at	string	註冊建立日期或時間

列表分享連結

作業識別碼：

GetBundles

列表分享連結

傳回

名稱	路徑	類型	Description
		array of object
字碼	code	string	打包程式碼。 此程式碼構成公開網址的末尾部分。
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	url	string	分享連結的公開網址
描述	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	如果屬實，我們將在 Bundle 註冊頁面隱藏「Remember Me」框，要求用戶每次造訪該頁面時都必須登出再重新登入。
clickwrap_body	clickwrap_body	string	存取 Bundle 前必須同意的法律條文。
識別碼	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	任何相關的收件匣註冊或 BundleRegistrations 都可以儲存，但不提供名稱
skip_email	form_field_set.skip_email	boolean	任何相關的收件匣註冊或 BundleRegistrations 都可以在不提供電子郵件的情況下儲存
skip_company	form_field_set.skip_company	boolean	任何相關的收件匣註冊或捆綁註冊都可以在不提供公司的情況下儲存
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	BundleRegistrations 可以在不提供公司的情況下保存嗎？
識別碼	id	integer	套件組合識別碼
建立於	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	包含此套件內容的快照的識別碼。
用戶識別碼	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	array of object	此叢中叢路徑的列表。 出於效能考量，這些資訊在列出組合包時不會提供。
items	bundlepaths	object

列表分享連結通知

作業識別碼：

GetBundleNotifications

列表分享連結通知

傳回

名稱	路徑	類型	Description
		array of object
bundle_id	bundle_id	integer	Bundle ID 要通知
識別碼	id	integer	組合通知ID
notify_on_registration	notify_on_registration	boolean	當該裝置發生註冊動作時，會觸發 bundle 通知。
notify_on_upload	notify_on_upload	boolean	當上傳動作發生時，會觸發 bundle 通知。
notify_user_id	notify_user_id	integer	通知使用者的 ID。

刪除 分享連結

作業識別碼：

DeleteBundlesId

刪除 分享連結

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	integer	組合識別碼。

刪除 分享連結通知

作業識別碼：

DeleteBundleNotificationsId

刪除 分享連結通知

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	integer	套裝通知 ID。

刪除使用者

作業識別碼：

DeleteUsersId

刪除使用者

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	integer	使用者識別碼。

刪除檔案或資料夾

作業識別碼：

DeleteFilesPath

刪除檔案或資料夾

參數

名稱	機碼	必要	類型	Description
路徑	path	True	string	手術路徑。

刪除群組

作業識別碼：

DeleteGroupsId

刪除群組

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	integer	群組 ID。

建立 分享 連結

作業識別碼：

PostBundles

建立 分享 連結

參數

名稱	機碼	必要	類型	Description
Description	description		string	公開描述
過期時間	expires_at		date-time	組合的有效期限/時間
最大使用次數	max_uses		integer	該組合可存取的最大次數
備註	note		string	束內音
密碼	password		string	這個組合的密碼。
Paths	paths	True	array of string	本套裝中應包含的路徑列表。
要求註冊	require_registration		boolean	顯示一個註冊頁面，能記錄下載者的姓名和電子郵件地址？

傳回

名稱	路徑	類型	Description
字碼	code	string	打包程式碼。 此程式碼構成公開網址的末尾部分。
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	url	string	分享連結的公開網址
描述	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	如果屬實，我們將在 Bundle 註冊頁面隱藏「Remember Me」框，要求用戶每次造訪該頁面時都必須登出再重新登入。
clickwrap_body	clickwrap_body	string	存取 Bundle 前必須同意的法律條文。
識別碼	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	任何相關的收件匣註冊或 BundleRegistrations 都可以儲存，但不提供名稱
skip_email	form_field_set.skip_email	boolean	任何相關的收件匣註冊或 BundleRegistrations 都可以在不提供電子郵件的情況下儲存
skip_company	form_field_set.skip_company	boolean	任何相關的收件匣註冊或捆綁註冊都可以在不提供公司的情況下儲存
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	BundleRegistrations 可以在不提供公司的情況下保存嗎？
識別碼	id	integer	套件組合識別碼
建立於	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	包含此套件內容的快照的識別碼。
用戶識別碼	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	array of object	此叢中叢路徑的列表。 出於效能考量，這些資訊在列出組合包時不會提供。
items	bundlepaths	object

建立 分享 連結收件人

作業識別碼：

PostBundleRecipients

建立 分享 連結收件人

參數

名稱	機碼	必要	類型	Description
套件組合 ID	bundle_id	True	integer	捆綁分享。
公司	company		string	收件人公司。
名稱	name		string	收件人姓名。
備註	note		string	請在電子郵件中註明。
Recipient	recipient	True	string	分享此組合包的電子郵件地址。

傳回

名稱	路徑	類型	Description
公司	company	string	收件人的公司。
名稱	name	string	收件人的名字。
注意	note	string	一封隨包裹寄給收件人的便條。
收件者	recipient	string	收件者的電子郵件地址。
sent_at	sent_at	string	當包裹與這位收禮者共享時，

建立使用者

作業識別碼：

PostUsers

建立使用者

參數

名稱	機碼	必要	類型	Description
驗證方法	authentication_method		string	這個使用者是如何被認證的？
公司	company		string	使用者公司
Email	email		string	使用者的電子郵件。
群組識別碼	group_ids		string	一份要將此使用者關聯的群組 ID 清單。 逗號分隔。
名稱	name		string	使用者的全名
註釋	notes		string	使用者的內部備註
密碼	password		string	使用者密碼。
要求更改密碼	require_password_change		boolean	下次使用者登入時是否需要更改密碼？
使用者首頁	user_home		string	FTP/SFTP 的 Home 資料夾。 請注意，這不適用於 API、桌面或網頁介面。
使用者根	user_root		string	FTP 的根目錄（如果設定了適當的全站設定，也可以選擇 SFTP）。 請注意，這不適用於 API、桌面或網頁介面。
用戶名稱	username	True	string	使用者用戶名

傳回

名稱	路徑	類型	Description
識別碼	id	integer	使用者識別碼
使用者名稱	username	string	使用者用戶名
admin_group_ids	admin_group_ids	array of integer	此使用者為管理員的群組 ID 列表
allowed_ips	allowed_ips	string	如果適用，請提供允許的 IP 清單。 Newline 界定
attachments_permission	attachments_permission	boolean	如果 true，使用者可以建立組合包（又稱分享連結）。 改用 bundle 權限吧。
api_keys_count	api_keys_count	integer	與此使用者關聯的 API 金鑰數量
authenticate_until	authenticate_until	string	預定的停用日期或時間
authentication_method	authentication_method	string	這個使用者是如何被認證的？
avatar_url	avatar_url	string	網址中儲存使用者頭像
可計費	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	計算屬性，若使用者停用、過期或非啟用，則會回傳為真。
電子郵件	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	使用者介面標頭中顯示的文字
語言	language	string	首選語言
last_login_at	last_login_at	string	使用者透過任何協定最近一次登入時間
last_web_login_at	last_web_login_at	string	使用者最近一次透過網頁登入的時間
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	last_active_at	string	使用者最近的活動時間，也就是最近一次登入、最近一次 API 使用、啟用或建立的時間
last_protocol_cipher	last_protocol_cipher	string	最新使用的協議與密碼
lockout_expires	lockout_expires	string	未來若適用，使用者將不再被鎖定
名稱	name	string	使用者的全名
公司	company	string	使用者公司
附註	notes	string	使用者的內部備註
notification_daily_send_time	notification_daily_send_time	integer	每天通知應該在哪個時段發送。 範圍可為0到23
office_integration_enabled	office_integration_enabled	boolean	啟用與 Office for the Web 的整合？
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	使用者的雙重驗證是否啟用？
require_password_change	require_password_change	boolean	下次使用者登入時是否需要更改密碼？
password_expired	password_expired	boolean	使用者的密碼過期了嗎？
readonly_site_admin	readonly_site_admin	boolean	使用者是否可以查看這個網站的所有（非計費）網站設定？
restapi_permission	restapi_permission	boolean	這個使用者能存取網頁應用程式、桌面應用程式、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	在介面中跳過歡迎頁面？
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	用於程式化用途的雙重驗證方法類型。 將以 sms、 totp、 webauthnyubiemail，或多個按字母順序排序並以底線連接的值。 未指定使用者是否擁有多於一種特定方法。
type_of_2fa_for_display	type_of_2fa_for_display	string	目前使用的雙重認證方法類型，格式化以便於使用者介面中顯示。 與 type_of_2fa不同，這個值會清楚顯示使用者是否擁有多個相同類型的方法。
user_root	user_root	string	FTP 的根目錄（如果設定了適當的全站設定，也可以選擇 SFTP）。 請注意，這不適用於 API、桌面或網頁介面。
user_home	user_home	string	FTP 或 SFTP 的 Home 資料夾。 請注意，這不適用於 API、桌面或網頁介面。
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	距離密碼到期還有多少天數
password_expire_at	password_expire_at	string	密碼到期日期時間

建立分享連結通知

作業識別碼：

PostBundleNotifications

建立分享連結通知

參數

名稱	機碼	必要	類型	Description
套件組合 ID	bundle_id	True	integer	Bundle ID 要通知
通知使用者ID	notify_user_id		integer	通知使用者的 ID。

傳回

名稱	路徑	類型	Description
bundle_id	bundle_id	integer	Bundle ID 要通知
識別碼	id	integer	組合通知ID
notify_on_registration	notify_on_registration	boolean	當該裝置發生註冊動作時，會觸發 bundle 通知。
notify_on_upload	notify_on_upload	boolean	當上傳動作發生時，會觸發 bundle 通知。
notify_user_id	notify_user_id	integer	通知使用者的 ID。

建立群組

作業識別碼：

PostGroups

建立群組

參數

名稱	機碼	必要	類型	Description
管理員 ID	admin_ids		string	一份群組管理員使用者 ID 清單。 如果以字串形式傳送，應使用逗號分隔。
名稱	name	True	string	組名。
註釋	notes		string	群組筆記。
使用者 ID	user_ids		string	一份使用者 ID 清單。 如果以字串形式傳送，應使用逗號分隔。

傳回

名稱	路徑	類型	Description
識別碼	id	integer	群組識別碼
名稱	name	string	群組名稱
allowed_ips	allowed_ips	string	如果適用，請提供允許的 IP 清單。 Newline 界定
admin_ids	admin_ids	string	以逗號分隔的群組管理員使用者 ID 列表（以逗號分隔）
附註	notes	string	關於此團體的備註
user_ids	user_ids	string	以逗號分隔的屬於此群組的使用者 ID 列表（以逗號分隔）
usernames	usernames	string	以逗號分隔的用戶名列表（以逗號分隔）
ftp_permission	ftp_permission	boolean	如果屬實，該群組的用戶可以使用 FTP 登入。 這會覆蓋使用者層級的錯誤值 ftp_permission 。
sftp_permission	sftp_permission	boolean	如果屬實，該群組的用戶可以使用 SFTP 登入。 這會覆蓋使用者層級的錯誤值 sftp_permission 。
dav_permission	dav_permission	boolean	如果屬實，該群組的用戶可以使用 WebDAV 登入。 這會覆蓋使用者層級的錯誤值 dav_permission 。
restapi_permission	restapi_permission	boolean	如果屬實，該群組的使用者可以使用 REST API 登入。 這會覆蓋使用者層級的錯誤值 restapi_permission 。
site_id	site_id	integer	站台識別碼

建立資料夾

作業識別碼：

PostFoldersPath

建立資料夾

參數

名稱	機碼	必要	類型	Description
路徑	path	True	string	手術路徑。

傳回

名稱	路徑	類型	Description
路徑	path	string	檔案或資料夾路徑。 這必須以斜線分隔，但不能以斜線開頭或結尾。 最多5000字元。
created_by_id	created_by_id	integer	建立該檔案或資料夾的使用者 ID
created_by_api_key_id	created_by_api_key_id	integer	建立檔案或資料夾的 API 金鑰的識別碼
created_by_as2_incoming_message_id	created_by_as2_incoming_message_id	integer	建立該檔案或資料夾的 AS2 入信的識別碼
created_by_automation_id	created_by_automation_id	integer	建立該檔案或資料夾的自動化識別碼
created_by_bundle_registration_id	created_by_bundle_registration_id	integer	建立該檔案或資料夾的 Bundle 註冊的 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_sync_id	created_by_sync_id	integer	建立該檔案或資料夾的同步識別碼
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	最後修改該檔案或資料夾的自動化識別碼
last_modified_by_bundle_registration_id	last_modified_by_bundle_registration_id	integer	最後修改該檔案或資料夾的 Bundle 註冊的 ID
last_modified_by_remote_server_id	last_modified_by_remote_server_id	integer	最後修改該檔案或資料夾的遠端伺服器識別碼
last_modified_by_sync_id	last_modified_by_sync_id	integer	最後修改該檔案或資料夾的同步識別碼
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類型	mime_type	string	啞劇類型。 這是由檔案副檔名決定，內部不會單獨儲存。
區域	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
識別碼	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	預覽尺寸

更新 分享連結

作業識別碼：

PatchBundlesId

更新 分享連結

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	integer	組合識別碼。
過期時間	expires_at		date-time	組合的有效期限/時間

傳回

名稱	路徑	類型	Description
字碼	code	string	打包程式碼。 此程式碼構成公開網址的末尾部分。
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	url	string	分享連結的公開網址
描述	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	如果屬實，我們將在 Bundle 註冊頁面隱藏「Remember Me」框，要求用戶每次造訪該頁面時都必須登出再重新登入。
clickwrap_body	clickwrap_body	string	存取 Bundle 前必須同意的法律條文。
識別碼	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	任何相關的收件匣註冊或 BundleRegistrations 都可以儲存，但不提供名稱
skip_email	form_field_set.skip_email	boolean	任何相關的收件匣註冊或 BundleRegistrations 都可以在不提供電子郵件的情況下儲存
skip_company	form_field_set.skip_company	boolean	任何相關的收件匣註冊或捆綁註冊都可以在不提供公司的情況下儲存
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	BundleRegistrations 可以在不提供公司的情況下保存嗎？
識別碼	id	integer	套件組合識別碼
建立於	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	包含此套件內容的快照的識別碼。
用戶識別碼	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	array of object	此叢中叢路徑的列表。 出於效能考量，這些資訊在列出組合包時不會提供。
items	bundlepaths	object

更新 分享連結通知

作業識別碼：

PatchBundleNotificationsId

更新 分享連結通知

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	integer	套裝通知 ID。
報名時通知	notify_on_registration		boolean	當該裝置發生註冊動作時，會觸發 bundle 通知。
上傳時通知	notify_on_upload		boolean	當上傳動作發生時，會觸發 bundle 通知。

傳回

名稱	路徑	類型	Description
bundle_id	bundle_id	integer	Bundle ID 要通知
識別碼	id	integer	組合通知ID
notify_on_registration	notify_on_registration	boolean	當該裝置發生註冊動作時，會觸發 bundle 通知。
notify_on_upload	notify_on_upload	boolean	當上傳動作發生時，會觸發 bundle 通知。
notify_user_id	notify_user_id	integer	通知使用者的 ID。

更新使用者

作業識別碼：

PatchUser

更新使用者

參數

名稱	機碼	必要	類型	Description
驗證方法	authentication_method		string	這個使用者是如何被認證的？
公司	company		string	使用者公司
Email	email		string	使用者的電子郵件。
群組識別碼	group_ids		string	一份要將此使用者關聯的群組 ID 清單。 逗號分隔。
名稱	name		string	使用者的全名
註釋	notes		string	使用者的內部備註
密碼	password		string	使用者密碼。
要求更改密碼	require_password_change		boolean	下次使用者登入時是否需要更改密碼？
使用者首頁	user_home		string	FTP/SFTP 的 Home 資料夾。 請注意，這不適用於 API、桌面或網頁介面。
使用者根	user_root		string	FTP 的根目錄（如果設定了適當的全站設定，也可以選擇 SFTP）。 請注意，這不適用於 API、桌面或網頁介面。
用戶名稱	username		string	使用者用戶名

傳回

名稱	路徑	類型	Description
識別碼	id	integer	使用者識別碼
使用者名稱	username	string	使用者用戶名
admin_group_ids	admin_group_ids	array of integer	此使用者為管理員的群組 ID 列表
allowed_ips	allowed_ips	string	如果適用，請提供允許的 IP 清單。 Newline 界定
attachments_permission	attachments_permission	boolean	如果 true，使用者可以建立組合包（又稱分享連結）。 改用 bundle 權限吧。
api_keys_count	api_keys_count	integer	與此使用者關聯的 API 金鑰數量
authenticate_until	authenticate_until	string	預定的停用日期或時間
authentication_method	authentication_method	string	這個使用者是如何被認證的？
avatar_url	avatar_url	string	網址中儲存使用者頭像
可計費	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	計算屬性，若使用者停用、過期或非啟用，則會回傳為真。
電子郵件	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	使用者介面標頭中顯示的文字
語言	language	string	首選語言
last_login_at	last_login_at	string	使用者透過任何協定最近一次登入時間
last_web_login_at	last_web_login_at	string	使用者最近一次透過網頁登入的時間
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	last_active_at	string	使用者最近的活動時間，也就是最近一次登入、最近一次 API 使用、啟用或建立的時間
last_protocol_cipher	last_protocol_cipher	string	最新使用的協議與密碼
lockout_expires	lockout_expires	string	未來若適用，使用者將不再被鎖定
名稱	name	string	使用者的全名
公司	company	string	使用者公司
附註	notes	string	使用者的內部備註
notification_daily_send_time	notification_daily_send_time	integer	每天通知應該在哪個時段發送。 範圍可為0到23
office_integration_enabled	office_integration_enabled	boolean	啟用與 Office for the Web 的整合？
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	使用者的雙重驗證是否啟用？
require_password_change	require_password_change	boolean	下次使用者登入時是否需要更改密碼？
password_expired	password_expired	boolean	使用者的密碼過期了嗎？
readonly_site_admin	readonly_site_admin	boolean	使用者是否可以查看這個網站的所有（非計費）網站設定？
restapi_permission	restapi_permission	boolean	這個使用者能存取網頁應用程式、桌面應用程式、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	在介面中跳過歡迎頁面？
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	用於程式化用途的雙重驗證方法類型。 將以 sms、 totp、 webauthnyubiemail，或多個按字母順序排序並以底線連接的值。 未指定使用者是否擁有多於一種特定方法。
type_of_2fa_for_display	type_of_2fa_for_display	string	目前使用的雙重認證方法類型，格式化以便於使用者介面中顯示。 與 type_of_2fa不同，這個值會清楚顯示使用者是否擁有多個相同類型的方法。
user_root	user_root	string	FTP 的根目錄（如果設定了適當的全站設定，也可以選擇 SFTP）。 請注意，這不適用於 API、桌面或網頁介面。
user_home	user_home	string	FTP 或 SFTP 的 Home 資料夾。 請注意，這不適用於 API、桌面或網頁介面。
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	距離密碼到期還有多少天數
password_expire_at	password_expire_at	string	密碼到期日期時間

更新使用者

作業識別碼：

PatchUsersId

更新使用者

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	integer	使用者識別碼。
驗證方法	authentication_method		string	這個使用者是如何被認證的？
公司	company		string	使用者公司
Email	email		string	使用者的電子郵件。
群組識別碼	group_ids		string	一份要將此使用者關聯的群組 ID 清單。 逗號分隔。
名稱	name		string	使用者的全名
註釋	notes		string	使用者的內部備註
密碼	password		string	使用者密碼。
要求更改密碼	require_password_change		boolean	下次使用者登入時是否需要更改密碼？
使用者首頁	user_home		string	FTP/SFTP 的 Home 資料夾。 請注意，這不適用於 API、桌面或網頁介面。
使用者根	user_root		string	FTP 的根目錄（如果設定了適當的全站設定，也可以選擇 SFTP）。 請注意，這不適用於 API、桌面或網頁介面。
用戶名稱	username		string	使用者用戶名

傳回

名稱	路徑	類型	Description
識別碼	id	integer	使用者識別碼
使用者名稱	username	string	使用者用戶名
admin_group_ids	admin_group_ids	array of integer	此使用者為管理員的群組 ID 列表
allowed_ips	allowed_ips	string	如果適用，請提供允許的 IP 清單。 Newline 界定
attachments_permission	attachments_permission	boolean	如果 true，使用者可以建立組合包（又稱分享連結）。 改用 bundle 權限吧。
api_keys_count	api_keys_count	integer	與此使用者關聯的 API 金鑰數量
authenticate_until	authenticate_until	string	預定的停用日期或時間
authentication_method	authentication_method	string	這個使用者是如何被認證的？
avatar_url	avatar_url	string	網址中儲存使用者頭像
可計費	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	計算屬性，若使用者停用、過期或非啟用，則會回傳為真。
電子郵件	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	使用者介面標頭中顯示的文字
語言	language	string	首選語言
last_login_at	last_login_at	string	使用者透過任何協定最近一次登入時間
last_web_login_at	last_web_login_at	string	使用者最近一次透過網頁登入的時間
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	last_active_at	string	使用者最近的活動時間，也就是最近一次登入、最近一次 API 使用、啟用或建立的時間
last_protocol_cipher	last_protocol_cipher	string	最新使用的協議與密碼
lockout_expires	lockout_expires	string	未來若適用，使用者將不再被鎖定
名稱	name	string	使用者的全名
公司	company	string	使用者公司
附註	notes	string	使用者的內部備註
notification_daily_send_time	notification_daily_send_time	integer	每天通知應該在哪個時段發送。 範圍可為0到23
office_integration_enabled	office_integration_enabled	boolean	啟用與 Office for the Web 的整合？
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	使用者的雙重驗證是否啟用？
require_password_change	require_password_change	boolean	下次使用者登入時是否需要更改密碼？
password_expired	password_expired	boolean	使用者的密碼過期了嗎？
readonly_site_admin	readonly_site_admin	boolean	使用者是否可以查看這個網站的所有（非計費）網站設定？
restapi_permission	restapi_permission	boolean	這個使用者能存取網頁應用程式、桌面應用程式、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	在介面中跳過歡迎頁面？
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	用於程式化用途的雙重驗證方法類型。 將以 sms、 totp、 webauthnyubiemail，或多個按字母順序排序並以底線連接的值。 未指定使用者是否擁有多於一種特定方法。
type_of_2fa_for_display	type_of_2fa_for_display	string	目前使用的雙重認證方法類型，格式化以便於使用者介面中顯示。 與 type_of_2fa不同，這個值會清楚顯示使用者是否擁有多個相同類型的方法。
user_root	user_root	string	FTP 的根目錄（如果設定了適當的全站設定，也可以選擇 SFTP）。 請注意，這不適用於 API、桌面或網頁介面。
user_home	user_home	string	FTP 或 SFTP 的 Home 資料夾。 請注意，這不適用於 API、桌面或網頁介面。
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	距離密碼到期還有多少天數
password_expire_at	password_expire_at	string	密碼到期日期時間

更新群組

作業識別碼：

PatchGroupsId

更新群組

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	integer	群組 ID。
管理員 ID	admin_ids		string	一份群組管理員使用者 ID 清單。 如果以字串形式傳送，應使用逗號分隔。
名稱	name		string	組名。
註釋	notes		string	群組筆記。
使用者 ID	user_ids		string	一份使用者 ID 清單。 如果以字串形式傳送，應使用逗號分隔。

傳回

名稱	路徑	類型	Description
識別碼	id	integer	群組識別碼
名稱	name	string	群組名稱
allowed_ips	allowed_ips	string	如果適用，請提供允許的 IP 清單。 Newline 界定
admin_ids	admin_ids	string	以逗號分隔的群組管理員使用者 ID 列表（以逗號分隔）
附註	notes	string	關於此團體的備註
user_ids	user_ids	string	以逗號分隔的屬於此群組的使用者 ID 列表（以逗號分隔）
usernames	usernames	string	以逗號分隔的用戶名列表（以逗號分隔）
ftp_permission	ftp_permission	boolean	如果屬實，該群組的用戶可以使用 FTP 登入。 這會覆蓋使用者層級的錯誤值 ftp_permission 。
sftp_permission	sftp_permission	boolean	如果屬實，該群組的用戶可以使用 SFTP 登入。 這會覆蓋使用者層級的錯誤值 sftp_permission 。
dav_permission	dav_permission	boolean	如果屬實，該群組的用戶可以使用 WebDAV 登入。 這會覆蓋使用者層級的錯誤值 dav_permission 。
restapi_permission	restapi_permission	boolean	如果屬實，該群組的使用者可以使用 REST API 登入。 這會覆蓋使用者層級的錯誤值 restapi_permission 。
site_id	site_id	integer	站台識別碼

清單組

作業識別碼：

GetGroups

清單組

傳回

名稱	路徑	類型	Description
		array of object
識別碼	id	integer	群組識別碼
名稱	name	string	群組名稱
allowed_ips	allowed_ips	string	如果適用，請提供允許的 IP 清單。 Newline 界定
admin_ids	admin_ids	string	以逗號分隔的群組管理員使用者 ID 列表（以逗號分隔）
附註	notes	string	關於此團體的備註
user_ids	user_ids	string	以逗號分隔的屬於此群組的使用者 ID 列表（以逗號分隔）
usernames	usernames	string	以逗號分隔的用戶名列表（以逗號分隔）
ftp_permission	ftp_permission	boolean	如果屬實，該群組的用戶可以使用 FTP 登入。 這會覆蓋使用者層級的錯誤值 ftp_permission 。
sftp_permission	sftp_permission	boolean	如果屬實，該群組的用戶可以使用 SFTP 登入。 這會覆蓋使用者層級的錯誤值 sftp_permission 。
dav_permission	dav_permission	boolean	如果屬實，該群組的用戶可以使用 WebDAV 登入。 這會覆蓋使用者層級的錯誤值 dav_permission 。
restapi_permission	restapi_permission	boolean	如果屬實，該群組的使用者可以使用 REST API 登入。 這會覆蓋使用者層級的錯誤值 restapi_permission 。
site_id	site_id	integer	站台識別碼

為群組建立一個新的使用者帳號

作業識別碼：

PostGroupsGroupIdUsers

為群組建立一個新的使用者帳號

參數

名稱	機碼	必要	類型	Description
群組識別碼	group_id	True	integer	用來關聯這個使用者的群組ID。
驗證方法	authentication_method		string	這個使用者是如何被認證的？
公司	company		string	使用者公司
Email	email		string	使用者的電子郵件。
群組識別碼	group_ids		string	一份要將此使用者關聯的群組 ID 清單。 逗號分隔。
名稱	name		string	使用者的全名
註釋	notes		string	使用者的內部備註
密碼	password		string	使用者密碼。
要求更改密碼	require_password_change		boolean	下次使用者登入時是否需要更改密碼？
使用者首頁	user_home		string	FTP/SFTP 的 Home 資料夾。 請注意，這不適用於 API、桌面或網頁介面。
使用者根	user_root		string	FTP 的根目錄（如果設定了適當的全站設定，也可以選擇 SFTP）。 請注意，這不適用於 API、桌面或網頁介面。
用戶名稱	username	True	string	使用者用戶名

傳回

名稱	路徑	類型	Description
識別碼	id	integer	使用者識別碼
使用者名稱	username	string	使用者用戶名
admin_group_ids	admin_group_ids	array of integer	此使用者為管理員的群組 ID 列表
allowed_ips	allowed_ips	string	如果適用，請提供允許的 IP 清單。 Newline 界定
attachments_permission	attachments_permission	boolean	如果 true，使用者可以建立組合包（又稱分享連結）。 改用 bundle 權限吧。
api_keys_count	api_keys_count	integer	與此使用者關聯的 API 金鑰數量
authenticate_until	authenticate_until	string	預定的停用日期或時間
authentication_method	authentication_method	string	這個使用者是如何被認證的？
avatar_url	avatar_url	string	網址中儲存使用者頭像
可計費	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	計算屬性，若使用者停用、過期或非啟用，則會回傳為真。
電子郵件	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	使用者介面標頭中顯示的文字
語言	language	string	首選語言
last_login_at	last_login_at	string	使用者透過任何協定最近一次登入時間
last_web_login_at	last_web_login_at	string	使用者最近一次透過網頁登入的時間
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	last_active_at	string	使用者最近的活動時間，也就是最近一次登入、最近一次 API 使用、啟用或建立的時間
last_protocol_cipher	last_protocol_cipher	string	最新使用的協議與密碼
lockout_expires	lockout_expires	string	未來若適用，使用者將不再被鎖定
名稱	name	string	使用者的全名
公司	company	string	使用者公司
附註	notes	string	使用者的內部備註
notification_daily_send_time	notification_daily_send_time	integer	每天通知應該在哪個時段發送。 範圍可為0到23
office_integration_enabled	office_integration_enabled	boolean	啟用與 Office for the Web 的整合？
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	使用者的雙重驗證是否啟用？
require_password_change	require_password_change	boolean	下次使用者登入時是否需要更改密碼？
password_expired	password_expired	boolean	使用者的密碼過期了嗎？
readonly_site_admin	readonly_site_admin	boolean	使用者是否可以查看這個網站的所有（非計費）網站設定？
restapi_permission	restapi_permission	boolean	這個使用者能存取網頁應用程式、桌面應用程式、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	在介面中跳過歡迎頁面？
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	用於程式化用途的雙重驗證方法類型。 將以 sms、 totp、 webauthnyubiemail，或多個按字母順序排序並以底線連接的值。 未指定使用者是否擁有多於一種特定方法。
type_of_2fa_for_display	type_of_2fa_for_display	string	目前使用的雙重認證方法類型，格式化以便於使用者介面中顯示。 與 type_of_2fa不同，這個值會清楚顯示使用者是否擁有多個相同類型的方法。
user_root	user_root	string	FTP 的根目錄（如果設定了適當的全站設定，也可以選擇 SFTP）。 請注意，這不適用於 API、桌面或網頁介面。
user_home	user_home	string	FTP 或 SFTP 的 Home 資料夾。 請注意，這不適用於 API、桌面或網頁介面。
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	距離密碼到期還有多少天數
password_expire_at	password_expire_at	string	密碼到期日期時間

移動檔案或資料夾

作業識別碼：

FileActionMove

移動檔案或資料夾

參數

名稱	機碼	必要	類型	Description
路徑	path	True	string	手術路徑。
目的地	destination	True	string	移動目的地路徑。

傳回

名稱	路徑	類型	Description
狀態	status	string	檔案運作狀態。
file_migration_id	file_migration_id	integer	如果狀態是待處理，這是檔案遷移的 ID，用來檢查狀態更新。

節目使用者

作業識別碼：

GetUsersId

節目使用者

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	integer	使用者識別碼。

傳回

名稱	路徑	類型	Description
識別碼	id	integer	使用者識別碼
使用者名稱	username	string	使用者用戶名
admin_group_ids	admin_group_ids	array of integer	此使用者為管理員的群組 ID 列表
allowed_ips	allowed_ips	string	如果適用，請提供允許的 IP 清單。 Newline 界定
attachments_permission	attachments_permission	boolean	如果 true，使用者可以建立組合包（又稱分享連結）。 改用 bundle 權限吧。
api_keys_count	api_keys_count	integer	與此使用者關聯的 API 金鑰數量
authenticate_until	authenticate_until	string	預定的停用日期或時間
authentication_method	authentication_method	string	這個使用者是如何被認證的？
avatar_url	avatar_url	string	網址中儲存使用者頭像
可計費	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	計算屬性，若使用者停用、過期或非啟用，則會回傳為真。
電子郵件	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	使用者介面標頭中顯示的文字
語言	language	string	首選語言
last_login_at	last_login_at	string	使用者透過任何協定最近一次登入時間
last_web_login_at	last_web_login_at	string	使用者最近一次透過網頁登入的時間
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	last_active_at	string	使用者最近的活動時間，也就是最近一次登入、最近一次 API 使用、啟用或建立的時間
last_protocol_cipher	last_protocol_cipher	string	最新使用的協議與密碼
lockout_expires	lockout_expires	string	未來若適用，使用者將不再被鎖定
名稱	name	string	使用者的全名
公司	company	string	使用者公司
附註	notes	string	使用者的內部備註
notification_daily_send_time	notification_daily_send_time	integer	每天通知應該在哪個時段發送。 範圍可為0到23
office_integration_enabled	office_integration_enabled	boolean	啟用與 Office for the Web 的整合？
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	使用者的雙重驗證是否啟用？
require_password_change	require_password_change	boolean	下次使用者登入時是否需要更改密碼？
password_expired	password_expired	boolean	使用者的密碼過期了嗎？
readonly_site_admin	readonly_site_admin	boolean	使用者是否可以查看這個網站的所有（非計費）網站設定？
restapi_permission	restapi_permission	boolean	這個使用者能存取網頁應用程式、桌面應用程式、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	在介面中跳過歡迎頁面？
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	用於程式化用途的雙重驗證方法類型。 將以 sms、 totp、 webauthnyubiemail，或多個按字母順序排序並以底線連接的值。 未指定使用者是否擁有多於一種特定方法。
type_of_2fa_for_display	type_of_2fa_for_display	string	目前使用的雙重認證方法類型，格式化以便於使用者介面中顯示。 與 type_of_2fa不同，這個值會清楚顯示使用者是否擁有多個相同類型的方法。
user_root	user_root	string	FTP 的根目錄（如果設定了適當的全站設定，也可以選擇 SFTP）。 請注意，這不適用於 API、桌面或網頁介面。
user_home	user_home	string	FTP 或 SFTP 的 Home 資料夾。 請注意，這不適用於 API、桌面或網頁介面。
days_remaining_until_password_expire	days_remaining_until_password_expire	integer	距離密碼到期還有多少天數
password_expire_at	password_expire_at	string	密碼到期日期時間

節目組

作業識別碼：

GetGroupsId

節目組

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	integer	群組 ID。

傳回

名稱	路徑	類型	Description
識別碼	id	integer	群組識別碼
名稱	name	string	群組名稱
allowed_ips	allowed_ips	string	如果適用，請提供允許的 IP 清單。 Newline 界定
admin_ids	admin_ids	string	以逗號分隔的群組管理員使用者 ID 列表（以逗號分隔）
附註	notes	string	關於此團體的備註
user_ids	user_ids	string	以逗號分隔的屬於此群組的使用者 ID 列表（以逗號分隔）
usernames	usernames	string	以逗號分隔的用戶名列表（以逗號分隔）
ftp_permission	ftp_permission	boolean	如果屬實，該群組的用戶可以使用 FTP 登入。 這會覆蓋使用者層級的錯誤值 ftp_permission 。
sftp_permission	sftp_permission	boolean	如果屬實，該群組的用戶可以使用 SFTP 登入。 這會覆蓋使用者層級的錯誤值 sftp_permission 。
dav_permission	dav_permission	boolean	如果屬實，該群組的用戶可以使用 WebDAV 登入。 這會覆蓋使用者層級的錯誤值 dav_permission 。
restapi_permission	restapi_permission	boolean	如果屬實，該群組的使用者可以使用 REST API 登入。 這會覆蓋使用者層級的錯誤值 restapi_permission 。
site_id	site_id	integer	站台識別碼

複製檔案或資料夾

作業識別碼：

FileActionCopy

複製檔案或資料夾

參數

名稱	機碼	必要	類型	Description
路徑	path	True	string	手術路徑。
目的地	destination	True	string	複製目的地路徑。

傳回

名稱	路徑	類型	Description
狀態	status	string	檔案運作狀態。
file_migration_id	file_migration_id	integer	如果狀態是待處理，這是檔案遷移的 ID，用來檢查狀態更新。

顯示 分享連結

作業識別碼：

GetBundlesId

顯示 分享連結

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	integer	組合識別碼。

傳回

名稱	路徑	類型	Description
字碼	code	string	打包程式碼。 此程式碼構成公開網址的末尾部分。
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	url	string	分享連結的公開網址
描述	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	如果屬實，我們將在 Bundle 註冊頁面隱藏「Remember Me」框，要求用戶每次造訪該頁面時都必須登出再重新登入。
clickwrap_body	clickwrap_body	string	存取 Bundle 前必須同意的法律條文。
識別碼	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	任何相關的收件匣註冊或 BundleRegistrations 都可以儲存，但不提供名稱
skip_email	form_field_set.skip_email	boolean	任何相關的收件匣註冊或 BundleRegistrations 都可以在不提供電子郵件的情況下儲存
skip_company	form_field_set.skip_company	boolean	任何相關的收件匣註冊或捆綁註冊都可以在不提供公司的情況下儲存
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	BundleRegistrations 可以在不提供公司的情況下保存嗎？
識別碼	id	integer	套件組合識別碼
建立於	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	包含此套件內容的快照的識別碼。
用戶識別碼	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	array of object	此叢中叢路徑的列表。 出於效能考量，這些資訊在列出組合包時不會提供。
items	bundlepaths	object

顯示 分享連結通知

作業識別碼：

GetBundleNotificationsId

顯示 分享連結通知

參數

名稱	機碼	必要	類型	Description
身份識別碼	id	True	integer	套裝通知 ID。

傳回

名稱	路徑	類型	Description
bundle_id	bundle_id	integer	Bundle ID 要通知
識別碼	id	integer	組合通知ID
notify_on_registration	notify_on_registration	boolean	當該裝置發生註冊動作時，會觸發 bundle 通知。
notify_on_upload	notify_on_upload	boolean	當上傳動作發生時，會觸發 bundle 通知。
notify_user_id	notify_user_id	integer	通知使用者的 ID。

定義

二進位

這是基本資料類型「二進位」。