watermint toolbox - The multi-purpose utility command-line tool for web services

メンバー管理コマンド

情報コマンド

以下のコマンドは、チームメンバーの情報を取得するためのものです.

コマンド 説明
member list チームメンバーの一覧
member feature メンバーの機能設定一覧
member folder list 各メンバーのフォルダを検索
member quota list メンバーの容量制限情報を一覧します
member quota usage チームメンバーのストレージ利用状況を取得
team activity user ユーザーごとのアクティビティ

基本管理コマンド

以下のコマンドは、チームメンバーのアカウントを管理するためのものです. これらのコマンドは、CSVファイルによる一括処理を行うためのものです.

コマンド 説明
member invite メンバーを招待します
member delete メンバーを削除します
member detach Dropbox BusinessユーザーをBasicユーザーに変更します
member reinvite 招待済み状態メンバーをチームに再招待します
member update email メンバーのメールアドレス処理
member update profile メンバーのプロフィール変更
member update visible メンバーへのディレクトリ制限を無効にします
member update invisible メンバーへのディレクトリ制限を有効にします
member quota update チームメンバーの容量制限を変更

メンバープロファイル設定コマンド

メンバープロフィールコマンドは、メンバーのプロフィール情報を一括して更新するためのものです. メンバーのメールアドレスを更新する必要がある場合は、member update emailコマンドを使用します. コマンドmember update emailは、CSVファイルを受信してメールアドレスを一括更新します. メンバーの表示名を更新する必要がある場合は、member update profileコマンドを使用します.

コマンド 説明
member update email メンバーのメールアドレス処理
member update profile メンバーのプロフィール変更

メンバーのストレージ クォータ制御コマンド

既存のメンバーストレージのクォータの設定や使用状況は、member quota listmember quota usageコマンドで確認できます. メンバークオータを更新する必要がある場合は、member quota updateコマンドを使用します. コマンド member quota update は、ストレージのクォータ設定を一括更新するためのCSV入力を受け付けます.

コマンド 説明
member quota list メンバーの容量制限情報を一覧します
member quota usage チームメンバーのストレージ利用状況を取得
member quota update チームメンバーの容量制限を変更

メンバーの一時停止/停止解除には、2種類のコマンドがあります. メンバーを一人ずつ一時停止/停止解除したい場合は、member suspendまたはmember unsuspendを使用してください. また、CSVファイルを使ってメンバーの一時停止や停止解除を行う場合は、member batch suspendmember batch unsuspendコマンドをご利用ください.

メンバーの一時停止/停止解除

コマンド 説明
member suspend メンバーの一時停止処理
member unsuspend メンバーの一時停止を解除する
member batch suspend メンバーの一括一時停止
member batch unsuspend メンバーの一括停止解除

ディレクトリ制限コマンド

ディレクトリ制限は、Dropbox Businessの機能で、メンバーを他の人から隠すことができます. 以下のコマンドは、この設定を更新して、他の人からメンバーを隠したり、設定を解除したりします.

コマンド 説明
member update visible メンバーへのディレクトリ制限を無効にします
member update invisible メンバーへのディレクトリ制限を有効にします

グループのコマンド

グループ管理コマンド

以下のコマンドはグループを管理するためのものです.

コマンド 説明
group add グループを作成します
group delete グループを削除します
group batch add グループの一括追加
group batch delete グループの削除
group list グループを一覧
group rename グループの改名

グループメンバー管理コマンド

グループメンバーの追加・削除・更新は、以下のコマンドで行うことができます. グループメンバーをCSVファイルで追加/削除/更新したい場合は、group member batch add, group member batch delete, group member batch deleteを用います.

コマンド 説明
group member add メンバーをグループに追加
group member delete メンバーをグループから削除
group member list グループに所属するメンバー一覧を取得します
group member batch add グループにメンバーを一括追加
group member batch delete グループからメンバーを削除
group member batch update グループからメンバーを追加または削除

未使用のグループの検索と削除

未使用のグループを探すには2つのコマンドがあります. 最初のコマンドは group list です. コマンド group list は、各グループのメンバー数を報告します. 0の場合は、フォルダに権限を追加するためのグループが現在使用されていません. どのフォルダが各グループを使用しているかを確認したい場合は、group folder listというコマンドを使います. group folder listでは、グループとフォルダのマッピングを報告します. group_with_no_foldersというレポートでは、フォルダがないグループが表示されます. グループの削除は、メンバー数とフォルダ数の両方を確認すれば、安全に行うことができます. 確認後、group batch deleteコマンドでグループを一括削除することができます.

コマンド 説明
group list グループを一覧
group folder list 各グループのフォルダを探す
group batch delete グループの削除

チームコンテンツのコマンド

管理者はDropbox Business APIを使って、チームフォルダ、共有フォルダ、メンバーのフォルダのコンテンツを扱うことができます. これらのコマンドの使用には注意が必要です. 名前空間とは、Dropbox APIの中で、フォルダの権限や設定を管理するための用語です. 共有フォルダ、チームフォルダ、チームフォルダ内のネストしたフォルダ、メンバーのルートフォルダ、メンバーのアプリフォルダなどのフォルダタイプは、すべて名前空間として管理されます. 名前空間コマンドでは、チームフォルダやメンバーズフォルダなど、あらゆる種類のフォルダを扱うことができます. しかし、特定のフォルダタイプのコマンドは、より多くの機能や詳細な情報がレポートに含まれています.

チームフォルダ操作コマンド

以下のコマンドを使って、チームフォルダーの作成、アーカイブ、完全に削除ができます. 複数のチームフォルダを扱う必要がある場合は、teamfolder batchコマンドの使用をご検討ください.

コマンド 説明
teamfolder list チームフォルダの一覧
teamfolder policy list チームフォルダのポリシー一覧
teamfolder file size チームフォルダのサイズを計算
teamfolder add チームフォルダを追加します
teamfolder archive チームフォルダのアーカイブ
teamfolder permdelete チームフォルダを完全に削除します
teamfolder batch archive 複数のチームフォルダをアーカイブします
teamfolder batch permdelete 複数のチームフォルダを完全に削除します
teamfolder batch replication チームフォルダの一括レプリケーション

チームフォルダの権限コマンド

チームフォルダーやサブフォルダーにメンバーを一括で追加・削除するには、以下のコマンドを使います.

コマンド 説明
teamfolder member list チームフォルダのメンバー一覧
teamfolder member add チームフォルダへのユーザー/グループの一括追加
teamfolder member delete チームフォルダからのユーザー/グループの一括削除

チームフォルダと共有フォルダのコマンド

以下のコマンドは、チームフォルダとチームの共有フォルダの両方に対応しています. 特定のフォルダを実際に使用している人を知りたい場合は、team content mount listというコマンドの使用をご検討ください. マウントは、ユーザーが自分のDropboxアカウントに共有フォルダを追加した状態です.

コマンド 説明
team content member list チームフォルダや共有フォルダのメンバー一覧
team content member size チームフォルダや共有フォルダのメンバー数をカウントする
team content mount list チームメンバーのマウント済み/アンマウント済みの共有フォルダをすべてリストアップします.
team content policy list チームフォルダと共有フォルダのポリシー一覧

チームスペースコマンド

チームスペースのためのコマンド。

コマンド 説明
teamspace asadmin file list チームスペース内のファイルやフォルダーを一覧表示することができます。
teamspace asadmin folder add チームスペースにトップレベルのフォルダーを作成
teamspace asadmin folder delete チームスペースのトップレベルフォルダーを削除する
teamspace asadmin folder permdelete チームスペースのトップレベルフォルダを完全に削除します。
teamspace asadmin member list トップレベルのフォルダーメンバーをリストアップ
teamspace file list チームスペースにあるファイルやフォルダーを一覧表示

名前空間コマンド

コマンド 説明
team namespace list チーム内すべての名前空間を一覧
team namespace summary チーム・ネームスペースの状態概要を報告する.
team namespace file list チーム内全ての名前空間でのファイル・フォルダを一覧
team namespace file size チーム内全ての名前空間でのファイル・フォルダを一覧
team namespace member list チームフォルダ以下のファイル・フォルダを一覧

チームのファイルリクエスト コマンド

コマンド 説明
team filerequest list チームないのファイルリクエストを一覧します

メンバーファイルのコマンド

コマンド 説明
member file permdelete チームメンバーの指定したパスのファイルまたはフォルダを完全に削除します

チーム共有リンクコマンド

チーム共有リンクコマンドは、チーム内のすべての共有リンクを一覧表示したり、指定した共有リンクを更新・削除することができます.

コマンド 説明
team sharedlink list 共有リンクの一覧
team sharedlink cap expiry チーム内の共有リンクに有効期限の上限を設定
team sharedlink cap visibility チーム内の共有リンクに可視性の上限を設定
team sharedlink update expiry チーム内の公開されている共有リンクについて有効期限を更新します
team sharedlink update password 共有リンクのパスワードの設定・更新
team sharedlink update visibility 共有リンクの可視性の更新
team sharedlink delete links 共有リンクの一括削除
team sharedlink delete member メンバーの共有リンクをすべて削除

コマンド team sharedlink update は、共有リンクに値を設定するためのものです. コマンド team sharedlink cap は、共有リンクにキャップ値を設定するためのものです. 例:有効期限を2021-05-06に設定して、team sharedlink update expiryで設定した場合. このコマンドは、既存のリンクが2021-05-04のように短い有効期限を持っている場合でも、有効期限を2021-05-06に更新します. 一方、team sharedlink cap expiryは、リンクの有効期限が2021-05-07のように長い場合にリンクを更新します.

同様に、team sharedlink cap visibilityというコマンドは、リンクの保護された可視性が少ない場合にのみ、可視性を制限します. 例えば、パスワードのない共有リンクをteam_onlyにしたい場合などです. team sharelink cap visibility` は、リンクが公開されていてパスワードがない場合にteam_onlyへ可視性を更新します

例(リンクの一覧):

チーム内のすべてのパブリックリンクをリストアップ:

tbx team sharedlink list -visibility public

結果は、CSV、xlsx、JSON形式で保存されます. 共有リンクを更新するためのレポートを変更することができます. jqというコマンドに慣れていれば、以下のように直接CSVファイルを作成することができます.

tbx team sharedlink list -output json | jq '.sharedlink.url' > all_links.csv

リンク所有者のメールアドレスでフィルタリングされたリンクを一覧表示します:

tbx team sharedlink list -output json | jq 'select(.member.profile.email == "username@example.com") | .sharedlink.url'

例(リンクの削除):

CSVファイルに記載されているすべてのリンクを削除する

tbx team sharedlink delete links -file /PATH/TO/DATA.csv

jqコマンドに慣れていれば、以下のようにパイプから直接データを送ることができます(標準入力から読み込む場合は、-fileオプションにシングルダッシュ -を渡します).

tbx team sharedlink list -visibility public -output json | tbx team sharedlink delete links -file -

ファイルロック

ファイルロックコマンドは、現在のファイルロックを一覧表示したり、管理者としてファイルロックを解除することができます.

メンバーのファイルロックコマンド

コマンド 説明
member file lock all release メンバーのパスの下にあるすべてのロックを解除します
member file lock list パスの下にあるメンバーのロックを一覧表示
member file lock release メンバーとしてパスのロックを解除します

チームフォルダのファイルロックコマンド

コマンド 説明
teamfolder file list チームフォルダの一覧
teamfolder file lock all release チームフォルダのパスの下にあるすべてのロックを解除する
teamfolder file lock list チームフォルダ内のロックを一覧表示
teamfolder file lock release チームフォルダ内のパスのロックを解除

アクティビティ ログ コマンド

チーム活動ログのコマンドでは、特定のフィルターや視点で活動ログをエクスポートすることができます.

コマンド 説明
team activity batch user 複数ユーザーのアクティビティを一括取得します
team activity daily event アクティビティーを1日ごとに取得します
team activity event イベントログ
team activity user ユーザーごとのアクティビティ

接続されたアプリケーションとデバイスのコマンド.

以下のコマンドは、チーム内で接続されているデバイスやアプリケーションの情報を取得することができます.

コマンド 説明
team device list チーム内全てのデバイス/セッションを一覧します
team device unlink デバイスのセッションを解除します
team linkedapp list リンク済みアプリを一覧

その他の使用例

External ID

External IDは、Dropboxのどのユーザーインターフェースにも表示されない属性です. この属性は、Dropbox AD ConnectorなどのID管理ソフトウェアによって、DropboxとIDソース(Active Directoryや人事データベースなど)との関係を維持するためのものです. Dropbox AD Connectorを使用していて、新しいActive Directoryツリーを構築した場合は、以下のようになります. 古いActive Directoryツリーと新しいツリーとの関係を切断するために、既存の外部IDをクリアする必要があるかもしれません. External IDのクリアを省略すると、Dropbox AD Connectorが新しいツリーへの構成中に意図せずアカウントを削除してしまう可能性があります. 既存の外部IDを確認したい場合は、member listコマンドを使います. しかし、このコマンドはデフォルトでは外部IDを含みません. 以下のようにexperiment report_all_columnsオプションを追加してください

tbx member list -experiment report_all_columns
コマンド 説明
member list チームメンバーの一覧
member clear externalid メンバーのexternal_idを初期化します
member update externalid チームメンバーのExternal IDを更新します.
group list グループを一覧
group clear externalid グループの外部IDをクリアする

データ移行補助コマンド

データ移行補助コマンドは、メンバーフォルダやチームフォルダを別のアカウントやチームにコピーします. 実際にデータを移行する前に、これらのコマンドを使用してテストしてください.

コマンド 説明
member folder replication フォルダを他のメンバーの個人フォルダに複製します
member replication チームメンバーのファイルを複製します
teamfolder partial replication 部分的なチームフォルダの他チームへのレプリケーション
teamfolder replication チームフォルダを他のチームに複製します

チーム情報コマンド

コマンド 説明
team feature チームの機能を出力します
team info チームの情報

Paperコマンド

レガシーPaperコマンド

チームのレガシーPaperコンテンツのコマンドです. レガシーペーパーとマイグレーションの詳細については、公式ガイドをご覧ください.

コマンド 説明
team content legacypaper count メンバー1人あたりのPaper文書の枚数
team content legacypaper list チームメンバーのPaper文書リスト出力
team content legacypaper export チームメンバー全員のPaper文書をローカルパスにエクスポート.

チーム管理者用コマンド

以下のコマンドは、チーム管理者を管理するためのものです.

コマンド 説明
team admin list メンバーの管理者権限一覧
team admin role add メンバーに新しいロールを追加する
team admin role clear メンバーからすべての管理者ロールを削除する
team admin role delete メンバーからロールを削除する
team admin role list チームの管理者の役割を列挙
team admin group role add グループのメンバーにロールを追加する
team admin group role delete 例外グループのメンバーを除くすべてのメンバーからロールを削除する

チームメンバーとして実行するコマンド

チームメンバーとしてコマンドを実行することができます. 例えば、team runas file sync batch upを使えば、メンバーのフォルダにファイルをアップロードすることができます.

コマンド 説明
team runas file list メンバーとして実行するファイルやフォルダーの一覧
team runas file batch copy ファイル/フォルダーをメンバーとして一括コピー
team runas file sync batch up メンバーとして動作する一括同期
team runas sharedfolder list 共有フォルダーの一覧をメンバーとして実行
team runas sharedfolder isolate 所有する共有フォルダの共有を解除し、メンバーとして実行する外部共有フォルダから離脱する.
team runas sharedfolder mount add 指定したメンバーのDropboxに共有フォルダを追加する
team runas sharedfolder mount delete 指定されたユーザーが指定されたフォルダーをアンマウントする.
team runas sharedfolder mount list 指定されたメンバーがマウントしているすべての共有フォルダーをリストアップします.
team runas sharedfolder mount mountable メンバーがマウントできるすべての共有フォルダーをリストアップ.
team runas sharedfolder batch leave 共有フォルダからメンバーとして一括退出
team runas sharedfolder batch share メンバーのフォルダを一括で共有
team runas sharedfolder batch unshare メンバーのフォルダの共有を一括解除
team runas sharedfolder member batch add メンバーの共有フォルダにメンバーを一括追加
team runas sharedfolder member batch delete メンバーの共有フォルダからメンバーを一括削除

注意事項:

Dropbox Businessのコマンドを実行するには、管理者権限が必要です. 認証トークンは、Dropboxのサポートを含め、誰とも共有してはいけません.

}