Files.com (プレビュー)

Files.com コネクタは、Microsoft の自動化プラットフォーム全体の自動化されたワークフローと統合のために、Files.com に直接、高パフォーマンスの統合を提供します。

このコネクタは、次の製品とリージョンで使用できます。

サービス	クラス	リージョン
コピロット スタジオ	Premium	次を除くすべての Power Automate リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)
ロジック アプリ	Standard	次を除くすべての Logic Apps リージョン :      - Azure Government リージョン      - Azure China リージョン      - 米国国防総省 (DoD)
Power Apps	Premium	次を除くすべての Power Apps リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)
Power Automate（パワーオートメート）	Premium	次を除くすべての Power Automate リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)

お問い合わせ
名前	Files.com サポート
URL	https://www.files.com/contact
Email	support@files.com

コネクタ メタデータ
パブリッシャー	Files.com
Web サイト	https://www.files.com/
プライバシー ポリシー	https://www.files.com/legal/privacy
カテゴリ	コンテンツとファイル;IT 運用

Files.com Power Automate コネクタ

概要

Files.com コネクタは、Microsoft Power Automate と Azure Logic Apps から Files.com への直接的で高パフォーマンスの統合を提供します。 Files.com は、クラウドネイティブの次世代 MFT、SFTP、セキュリティで保護されたファイル共有プラットフォームであり、脆弱なレガシ サーバーを 1 つの常時接続のセキュリティで保護されたファブリックに置き換えます。 クラウド、プロトコル、またはパートナー全体でミッション クリティカルなファイル フローを自動化しながら、人間のコラボレーションをサポートし、手動作業を排除します。

注: このコネクタはアクションのみを提供し、トリガーはまだ含まれていません。

⸻

[前提条件]

このコネクタを使用する前に、次の 1 があることを確認してください。API キーを持つ有効な Files.com アカウント。 2. Microsoft Power Automate へのアクセス。

⸻

Authentication

このコネクタでは、API キー認証を使用します。 API キーは、次の Files.com アカウントで生成できます。

API キー→作成→ API キーの設定。

コネクタを構成するときに、認証フィールドに Files.com ホストと API キーを入力します。

例:

Host: yourcompany API Key: abc123456789...

すべての要求は次の宛先に送信されます。

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

⸻

ユース ケース 1 の例。ユーザーとグループの管理 Power Automate アクションを使用して、ユーザーの作成、更新、非アクティブ化、ロールの割り当て、グループ メンバーシップの直接管理を行います。 2. 共有リンク (バンドル) ワークフローを自動化する ファイル配信用の共有リンクを生成する、受信者を追加する、通知を構成する、またはアクセスを自動的に取り消す。 3.ファイルメタデータリストフォルダを同期し、ファイルメタデータを取得し、アクセス許可の変更やタグ付けなどの自動化ロジックを適用します。 4. ユーザー プロビジョニング ワークフローを構築し、HR または ID 管理システムを Files.com と統合して、変更が発生したときにユーザーを自動的に作成したり、アクセスを更新したりします。 5. ドキュメント配布をトリガーする Files.com アクションを OneDrive または SharePoint と組み合わせて、ドキュメントを安全に配布またはアーカイブします。

⸻

Support

コネクタのセットアップに関する技術的なサポートや質問については、Files.com サポートにお問い合わせください。 https://www.files.com/contact

Power Automate 固有の問題については、Microsoft のカスタム コネクタのドキュメントを参照してください。

⸻

法律に関する通知

このコネクタは、Files.com によって提供されます。 このコネクタを使用すると、Files.com サービス利用規約とプライバシー ポリシーに同意したものと見なされます。

接続を作成する

コネクタでは、次の認証の種類がサポートされています。

デフォルト	接続を作成するためのパラメーター。	すべてのリージョン	共有不可

デフォルト

適用対象: すべてのリージョン

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前	タイプ	Description	必須
APIキー	securestring	この API のapi_key	正しい

調整制限

名前	呼び出し	更新期間
接続ごとの API 呼び出し	100	60 秒

アクション

[Create User]	[Create User]
グループの作成	グループの作成
グループの削除	グループの削除
グループの新しいユーザー アカウントを作成する	グループの新しいユーザー アカウントを作成する
グループの更新	グループの更新
グループの表示	グループの表示
パスでファイルまたはフォルダーを検索する	パスでファイルまたはフォルダーを検索する
パス別にフォルダーを一覧表示する	パス別にフォルダーを一覧表示する
ファイルのアップロード	ファイルのアップロード
ファイルのダウンロード	ファイルのダウンロード
ファイルまたはフォルダーのコピー	ファイルまたはフォルダーのコピー
ファイルまたはフォルダーの削除	ファイルまたはフォルダーの削除
ファイルまたはフォルダーの移動	ファイルまたはフォルダーの移動
フォルダーの作成	フォルダーの作成
ユーザーの削除	ユーザーの削除
ユーザーの更新	ユーザーの更新
ユーザーの更新	ユーザーの更新
ユーザーの表示	ユーザーの表示
ユーザー一覧表示	ユーザー一覧表示
リストグループ	リストグループ
共有リンクのダウンロードを一覧表示する	共有リンクのダウンロードを一覧表示する
共有リンクの作成	共有リンクの作成
共有リンクの削除	共有リンクの削除
共有リンクの削除通知	共有リンクの削除通知
共有リンクの受信者を一覧表示する	共有リンクの受信者を一覧表示する
共有リンクの更新	共有リンクの更新
共有リンクの更新通知	共有リンクの更新通知
共有リンクの登録を一覧表示する	共有リンクの登録を一覧表示する
共有リンクの表示	共有リンクの表示
共有リンクの通知を表示する	共有リンクの通知を表示する
共有リンクを一覧表示する	共有リンクを一覧表示する
共有リンク受信者の作成	共有リンク受信者の作成
共有リンク通知の一覧表示	共有リンク通知の一覧表示
共有リンク通知の作成	共有リンク通知の作成

[Create User]

操作 ID:

PostUsers

[Create User]

パラメーター

名前	キー	必須	型	説明
認証方法	authentication_method		string	このユーザーはどのように認証されますか?
[会社]	company		string	ユーザーの会社
Email	email		string	ユーザーの電子メール。
グループ ID	group_ids		string	このユーザーを関連付けるグループ ID の一覧。 コンマ区切り。
名前	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 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	ユーザーの 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 を内部的に使用するため、これは 1 つの統合アクセス許可セットです)。
self_managed	self_managed	boolean	このユーザーは自分の資格情報を管理しますか、それとも共有ユーザーかボット ユーザーか。
sftp_permission	sftp_permission	boolean	ユーザーは SFTP でアクセスできますか?
site_admin	site_admin	boolean	ユーザーはこのサイトの管理者ですか?
site_id	site_id	integer	サイト ID
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 メソッドの型。 sms、totp、webauthn、yubi、email、または複数の値がアルファベット順に並べ替えられてアンダースコアで結合されます。 ユーザーが特定のメソッドを複数持っているかどうかを指定しません。
type_of_2fa_for_display	type_of_2fa_for_display	string	UI に表示するために書式設定された、使用中の 2FA メソッドの型。 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	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 を使用してログインできます。 これにより、ユーザー レベルの ftp_permission の false 値がオーバーライドされます。
sftp_permission	sftp_permission	boolean	true の場合、このグループのユーザーは SFTP を使用してログインできます。 これにより、ユーザー レベルの sftp_permission の false 値がオーバーライドされます。
dav_permission	dav_permission	boolean	true の場合、このグループのユーザーは WebDAV を使用してログインできます。 これにより、ユーザー レベルの dav_permission の false 値がオーバーライドされます。
restapi_permission	restapi_permission	boolean	true の場合、このグループのユーザーは REST API を使用してログインできます。 これにより、ユーザー レベルの restapi_permission の false 値がオーバーライドされます。
site_id	site_id	integer	サイト ID

グループの削除

操作 ID:

DeleteGroupsId

グループの削除

パラメーター

名前	キー	必須	型	説明
ID (アイディー)	id	True	integer	グループ ID。

グループの新しいユーザー アカウントを作成する

操作 ID:

PostGroupsGroupIdUsers

グループの新しいユーザー アカウントを作成する

パラメーター

名前	キー	必須	型	説明
グループ ID	group_id	True	integer	このユーザーを関連付けるグループ ID。
認証方法	authentication_method		string	このユーザーはどのように認証されますか?
[会社]	company		string	ユーザーの会社
Email	email		string	ユーザーの電子メール。
グループ ID	group_ids		string	このユーザーを関連付けるグループ ID の一覧。 コンマ区切り。
名前	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 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	ユーザーの 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 を内部的に使用するため、これは 1 つの統合アクセス許可セットです)。
self_managed	self_managed	boolean	このユーザーは自分の資格情報を管理しますか、それとも共有ユーザーかボット ユーザーか。
sftp_permission	sftp_permission	boolean	ユーザーは SFTP でアクセスできますか?
site_admin	site_admin	boolean	ユーザーはこのサイトの管理者ですか?
site_id	site_id	integer	サイト ID
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 メソッドの型。 sms、totp、webauthn、yubi、email、または複数の値がアルファベット順に並べ替えられてアンダースコアで結合されます。 ユーザーが特定のメソッドを複数持っているかどうかを指定しません。
type_of_2fa_for_display	type_of_2fa_for_display	string	UI に表示するために書式設定された、使用中の 2FA メソッドの型。 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		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 を使用してログインできます。 これにより、ユーザー レベルの ftp_permission の false 値がオーバーライドされます。
sftp_permission	sftp_permission	boolean	true の場合、このグループのユーザーは SFTP を使用してログインできます。 これにより、ユーザー レベルの sftp_permission の false 値がオーバーライドされます。
dav_permission	dav_permission	boolean	true の場合、このグループのユーザーは WebDAV を使用してログインできます。 これにより、ユーザー レベルの dav_permission の false 値がオーバーライドされます。
restapi_permission	restapi_permission	boolean	true の場合、このグループのユーザーは REST API を使用してログインできます。 これにより、ユーザー レベルの restapi_permission の false 値がオーバーライドされます。
site_id	site_id	integer	サイト ID

グループの表示

操作 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 を使用してログインできます。 これにより、ユーザー レベルの ftp_permission の false 値がオーバーライドされます。
sftp_permission	sftp_permission	boolean	true の場合、このグループのユーザーは SFTP を使用してログインできます。 これにより、ユーザー レベルの sftp_permission の false 値がオーバーライドされます。
dav_permission	dav_permission	boolean	true の場合、このグループのユーザーは WebDAV を使用してログインできます。 これにより、ユーザー レベルの dav_permission の false 値がオーバーライドされます。
restapi_permission	restapi_permission	boolean	true の場合、このグループのユーザーは REST API を使用してログインできます。 これにより、ユーザー レベルの restapi_permission の false 値がオーバーライドされます。
site_id	site_id	integer	サイト ID

パスでファイルまたはフォルダーを検索する

操作 ID:

FileActionFind

パスでファイルまたはフォルダーを検索する

パラメーター

名前	キー	必須	型	説明
経路	path	True	string	操作するパス。

戻り値

名前	パス	型	説明
パス	path	string	ファイルまたはフォルダーのパス。 これはスラッシュで区切る必要がありますが、スラッシュで始まりも終わりでもない必要があります。 最大 5,000 文字。
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	ファイルまたはフォルダーを作成した Automation の 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_sync_id	created_by_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	ファイルまたはフォルダーを最後に変更した Automation の 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_sync_id	last_modified_by_sync_id	integer	ファイルまたはフォルダーを最後に変更した同期の ID
Mtime	mtime	string	サーバーに応じて、ファイルが最後に変更された日付または時刻。 これは、送信された変更されたタイムスタンプに関係なく、ファイルの最後の Files.com 操作のタイムスタンプです。
provided_mtime	provided_mtime	string	ファイルを設定したクライアントに応じて、最後に変更された日付または時刻。 Files.com では、デスクトップ、FTP、SFTP、および WebDAV クライアントが変更時に設定できます。 これにより、Desktop<->Cloud 同期で、変更を一度に保持できます。
crc32	crc32	string	ファイル CRC32 チェックサム。 これは遅延する場合があるため、空の応答が返された場合は、しばらくしてからやり直してください。
md5	md5	string	ファイル MD5 チェックサム。 これは遅延する場合があるため、空の応答が返された場合は、しばらくしてからやり直してください。
sha1	sha1	string	ファイル SHA1 チェックサム。 これは遅延する場合があるため、空の応答が返された場合は、しばらくしてからやり直してください。
sha256	sha256	string	ファイル SHA256 チェックサム。 これは遅延する場合があるため、空の応答が返された場合は、しばらくしてからやり直してください。
MIMEタイプ	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:

FolderListForPath

パス別にフォルダーを一覧表示する

パラメーター

名前	キー	必須	型	説明
経路	path	True	string	操作するパス。

戻り値

名前	パス	型	説明
		array of object
パス	path	string	ファイルまたはフォルダーのパス。 これはスラッシュで区切る必要がありますが、スラッシュで始まりも終わりでもない必要があります。 最大 5,000 文字。
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	ファイルまたはフォルダーを作成した Automation の 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_sync_id	created_by_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	ファイルまたはフォルダーを最後に変更した Automation の 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_sync_id	last_modified_by_sync_id	integer	ファイルまたはフォルダーを最後に変更した同期の ID
Mtime	mtime	string	サーバーに応じて、ファイルが最後に変更された日付または時刻。 これは、送信された変更されたタイムスタンプに関係なく、ファイルの最後の Files.com 操作のタイムスタンプです。
provided_mtime	provided_mtime	string	ファイルを設定したクライアントに応じて、最後に変更された日付または時刻。 Files.com では、デスクトップ、FTP、SFTP、および WebDAV クライアントが変更時に設定できます。 これにより、Desktop<->Cloud 同期で、変更を一度に保持できます。
crc32	crc32	string	ファイル CRC32 チェックサム。 これは遅延する場合があるため、空の応答が返された場合は、しばらくしてからやり直してください。
md5	md5	string	ファイル MD5 チェックサム。 これは遅延する場合があるため、空の応答が返された場合は、しばらくしてからやり直してください。
sha1	sha1	string	ファイル SHA1 チェックサム。 これは遅延する場合があるため、空の応答が返された場合は、しばらくしてからやり直してください。
sha256	sha256	string	ファイル SHA256 チェックサム。 これは遅延する場合があるため、空の応答が返された場合は、しばらくしてからやり直してください。
MIMEタイプ	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:

UploadFile

ファイルのアップロード

パラメーター

名前	キー	必須	型	説明
経路	path	True	string	操作するパス。
ファイルの内容	body	True	binary	アップロードするファイルの内容。 Files.com に格納する正確なバイト数を送信します。

ファイルのダウンロード

操作 ID:

DownloadFile

ファイルのダウンロード

パラメーター

名前	キー	必須	型	説明
経路	path	True	string	操作するパス。

戻り値

ファイルの内容

binary

ファイルまたはフォルダーのコピー

操作 ID:

FileActionCopy

ファイルまたはフォルダーのコピー

パラメーター

名前	キー	必須	型	説明
経路	path	True	string	操作するパス。
行き先	destination	True	string	コピー先のパス。

戻り値

名前	パス	型	説明
状態	status	string	ファイル操作の状態。
file_migration_id	file_migration_id	integer	状態が保留中の場合は、状態の更新を確認するファイル移行の ID です。

ファイルまたはフォルダーの削除

操作 ID:

DeleteFilesPath

ファイルまたはフォルダーの削除

パラメーター

名前	キー	必須	型	説明
経路	path	True	string	操作するパス。

ファイルまたはフォルダーの移動

操作 ID:

FileActionMove

ファイルまたはフォルダーの移動

パラメーター

名前	キー	必須	型	説明
経路	path	True	string	操作するパス。
行き先	destination	True	string	移動先のパス。

戻り値

名前	パス	型	説明
状態	status	string	ファイル操作の状態。
file_migration_id	file_migration_id	integer	状態が保留中の場合は、状態の更新を確認するファイル移行の ID です。

フォルダーの作成

操作 ID:

PostFoldersPath

フォルダーの作成

パラメーター

名前	キー	必須	型	説明
経路	path	True	string	操作するパス。

戻り値

名前	パス	型	説明
パス	path	string	ファイルまたはフォルダーのパス。 これはスラッシュで区切る必要がありますが、スラッシュで始まりも終わりでもない必要があります。 最大 5,000 文字。
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	ファイルまたはフォルダーを作成した Automation の 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_sync_id	created_by_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	ファイルまたはフォルダーを最後に変更した Automation の 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_sync_id	last_modified_by_sync_id	integer	ファイルまたはフォルダーを最後に変更した同期の ID
Mtime	mtime	string	サーバーに応じて、ファイルが最後に変更された日付または時刻。 これは、送信された変更されたタイムスタンプに関係なく、ファイルの最後の Files.com 操作のタイムスタンプです。
provided_mtime	provided_mtime	string	ファイルを設定したクライアントに応じて、最後に変更された日付または時刻。 Files.com では、デスクトップ、FTP、SFTP、および WebDAV クライアントが変更時に設定できます。 これにより、Desktop<->Cloud 同期で、変更を一度に保持できます。
crc32	crc32	string	ファイル CRC32 チェックサム。 これは遅延する場合があるため、空の応答が返された場合は、しばらくしてからやり直してください。
md5	md5	string	ファイル MD5 チェックサム。 これは遅延する場合があるため、空の応答が返された場合は、しばらくしてからやり直してください。
sha1	sha1	string	ファイル SHA1 チェックサム。 これは遅延する場合があるため、空の応答が返された場合は、しばらくしてからやり直してください。
sha256	sha256	string	ファイル SHA256 チェックサム。 これは遅延する場合があるため、空の応答が返された場合は、しばらくしてからやり直してください。
MIMEタイプ	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:

DeleteUsersId

ユーザーの削除

パラメーター

名前	キー	必須	型	説明
ID (アイディー)	id	True	integer	ユーザー ID。

ユーザーの更新

操作 ID:

PatchUser

ユーザーの更新

パラメーター

名前	キー	必須	型	説明
認証方法	authentication_method		string	このユーザーはどのように認証されますか?
[会社]	company		string	ユーザーの会社
Email	email		string	ユーザーの電子メール。
グループ ID	group_ids		string	このユーザーを関連付けるグループ ID の一覧。 コンマ区切り。
名前	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 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	ユーザーの 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 を内部的に使用するため、これは 1 つの統合アクセス許可セットです)。
self_managed	self_managed	boolean	このユーザーは自分の資格情報を管理しますか、それとも共有ユーザーかボット ユーザーか。
sftp_permission	sftp_permission	boolean	ユーザーは SFTP でアクセスできますか?
site_admin	site_admin	boolean	ユーザーはこのサイトの管理者ですか?
site_id	site_id	integer	サイト ID
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 メソッドの型。 sms、totp、webauthn、yubi、email、または複数の値がアルファベット順に並べ替えられてアンダースコアで結合されます。 ユーザーが特定のメソッドを複数持っているかどうかを指定しません。
type_of_2fa_for_display	type_of_2fa_for_display	string	UI に表示するために書式設定された、使用中の 2FA メソッドの型。 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:

PatchUsersId

ユーザーの更新

パラメーター

名前	キー	必須	型	説明
ID (アイディー)	id	True	integer	ユーザー ID。
認証方法	authentication_method		string	このユーザーはどのように認証されますか?
[会社]	company		string	ユーザーの会社
Email	email		string	ユーザーの電子メール。
グループ ID	group_ids		string	このユーザーを関連付けるグループ ID の一覧。 コンマ区切り。
名前	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 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	ユーザーの 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 を内部的に使用するため、これは 1 つの統合アクセス許可セットです)。
self_managed	self_managed	boolean	このユーザーは自分の資格情報を管理しますか、それとも共有ユーザーかボット ユーザーか。
sftp_permission	sftp_permission	boolean	ユーザーは SFTP でアクセスできますか?
site_admin	site_admin	boolean	ユーザーはこのサイトの管理者ですか?
site_id	site_id	integer	サイト ID
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 メソッドの型。 sms、totp、webauthn、yubi、email、または複数の値がアルファベット順に並べ替えられてアンダースコアで結合されます。 ユーザーが特定のメソッドを複数持っているかどうかを指定しません。
type_of_2fa_for_display	type_of_2fa_for_display	string	UI に表示するために書式設定された、使用中の 2FA メソッドの型。 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:

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 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	ユーザーの 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 を内部的に使用するため、これは 1 つの統合アクセス許可セットです)。
self_managed	self_managed	boolean	このユーザーは自分の資格情報を管理しますか、それとも共有ユーザーかボット ユーザーか。
sftp_permission	sftp_permission	boolean	ユーザーは SFTP でアクセスできますか?
site_admin	site_admin	boolean	ユーザーはこのサイトの管理者ですか?
site_id	site_id	integer	サイト ID
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 メソッドの型。 sms、totp、webauthn、yubi、email、または複数の値がアルファベット順に並べ替えられてアンダースコアで結合されます。 ユーザーが特定のメソッドを複数持っているかどうかを指定しません。
type_of_2fa_for_display	type_of_2fa_for_display	string	UI に表示するために書式設定された、使用中の 2FA メソッドの型。 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:

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 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	ユーザーの 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 を内部的に使用するため、これは 1 つの統合アクセス許可セットです)。
self_managed	self_managed	boolean	このユーザーは自分の資格情報を管理しますか、それとも共有ユーザーかボット ユーザーか。
sftp_permission	sftp_permission	boolean	ユーザーは SFTP でアクセスできますか?
site_admin	site_admin	boolean	ユーザーはこのサイトの管理者ですか?
site_id	site_id	integer	サイト ID
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 メソッドの型。 sms、totp、webauthn、yubi、email、または複数の値がアルファベット順に並べ替えられてアンダースコアで結合されます。 ユーザーが特定のメソッドを複数持っているかどうかを指定しません。
type_of_2fa_for_display	type_of_2fa_for_display	string	UI に表示するために書式設定された、使用中の 2FA メソッドの型。 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 を使用してログインできます。 これにより、ユーザー レベルの ftp_permission の false 値がオーバーライドされます。
sftp_permission	sftp_permission	boolean	true の場合、このグループのユーザーは SFTP を使用してログインできます。 これにより、ユーザー レベルの sftp_permission の false 値がオーバーライドされます。
dav_permission	dav_permission	boolean	true の場合、このグループのユーザーは WebDAV を使用してログインできます。 これにより、ユーザー レベルの dav_permission の false 値がオーバーライドされます。
restapi_permission	restapi_permission	boolean	true の場合、このグループのユーザーは REST API を使用してログインできます。 これにより、ユーザー レベルの restapi_permission の false 値がオーバーライドされます。
site_id	site_id	integer	サイト ID

共有リンクのダウンロードを一覧表示する

操作 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	レジストリに表示されたテキストをクリックラップする
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	ダウンロード パス。 これはスラッシュで区切る必要がありますが、スラッシュで始まりも終わりでもない必要があります。 最大 5,000 文字。
作成日時	created_at	string	日付または時刻をダウンロードする

共有リンクの作成

操作 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	url	string	Share Link のパブリック 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	BundleRegistrations は会社を提供せずに保存できますか?
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	このバンドルで使用するクリックラップの ID。
inbox_id	inbox_id	integer	関連付けられている受信トレイの ID (使用可能な場合)。
名前	watermark_attachment.name	string	イメージ名
URI	watermark_attachment.uri	string	画像の URL
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:

DeleteBundlesId

共有リンクの削除

パラメーター

名前	キー	必須	型	説明
ID (アイディー)	id	True	integer	バンドル ID。

共有リンクの削除通知

操作 ID:

DeleteBundleNotificationsId

共有リンクの削除通知

パラメーター

名前	キー	必須	型	説明
ID (アイディー)	id	True	integer	バンドル通知 ID。

共有リンクの受信者を一覧表示する

操作 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:

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	url	string	Share Link のパブリック 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	BundleRegistrations は会社を提供せずに保存できますか?
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	このバンドルで使用するクリックラップの ID。
inbox_id	inbox_id	integer	関連付けられている受信トレイの ID (使用可能な場合)。
名前	watermark_attachment.name	string	イメージ名
URI	watermark_attachment.uri	string	画像の URL
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:

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	レジストリに表示されたテキストをクリックラップする
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:

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	url	string	Share Link のパブリック 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	BundleRegistrations は会社を提供せずに保存できますか?
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	このバンドルで使用するクリックラップの ID。
inbox_id	inbox_id	integer	関連付けられている受信トレイの ID (使用可能な場合)。
名前	watermark_attachment.name	string	イメージ名
URI	watermark_attachment.uri	string	画像の URL
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:

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	url	string	Share Link のパブリック 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	BundleRegistrations は会社を提供せずに保存できますか?
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	このバンドルで使用するクリックラップの ID。
inbox_id	inbox_id	integer	関連付けられている受信トレイの ID (使用可能な場合)。
名前	watermark_attachment.name	string	イメージ名
URI	watermark_attachment.uri	string	画像の URL
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		string	受信者の名前。
注	note		string	電子メールに含める場合に注意してください。
Recipient	recipient	True	string	このバンドルを共有するメール アドレス。

戻り値

名前	パス	型	説明
company	company	string	受信者の会社。
名前	name	string	受信者の名前。
メモ	note	string	バンドルを使用して受信者に送信されたメモ。
受信者	recipient	string	受信者の電子メール アドレス。
sent_at	sent_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:

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。

定義

binary

これは基本的なデータ型 'binary' です。