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

team runas sharedfolder batch leave

Batch leave from shared folders as a member

Security

watermint toolbox stores credentials into the file system. That is located at below path:

OS Path
Windows %HOMEPATH%\.toolbox\secrets (e.g. C:\Users\bob.toolbox\secrets)
macOS $HOME/.toolbox/secrets (e.g. /Users/bob/.toolbox/secrets)
Linux $HOME/.toolbox/secrets (e.g. /home/bob/.toolbox/secrets)

Please do not share those files to anyone including Dropbox support. You can delete those files after use if you want to remove it. If you want to make sure removal of credentials, revoke application access from setting or the admin console.

Please see below help article for more detail:

  • Dropbox Business: https://help.dropbox.com/installs-integrations/third-party/business-api#manage

Auth scopes

Description
Dropbox Business: View content of your Dropbox files and folders
Dropbox Business: View your team membership
Dropbox Business: View your Dropbox sharing settings and collaborators
Dropbox Business: View and manage your Dropbox sharing settings and collaborators
Dropbox Business: View structure of your team’s and members’ folders

Authorization

For the first run, tbx will ask you an authentication with your Dropbox account. Please copy the link and paste it into your browser. Then proceed to authorization. After authorization, Dropbox will show you an authorization code. Please copy that code and paste it to the tbx.


watermint toolbox xx.x.xxx
==========================

© 2016-2022 Takayuki Okazaki
Licensed under open source licenses. Use the `license` command for more detail.

1. Visit the URL for the auth dialogue:

https://www.dropbox.com/oauth2/authorize?client_id=xxxxxxxxxxxxxxx&response_type=code&state=xxxxxxxx

2. Click 'Allow' (you might have to login first):
3. Copy the authorisation code:
Enter the authorisation code

Installation

Please download the pre-compiled binary from Latest Release. If you are using Windows, please download the zip file like tbx-xx.x.xxx-win.zip. Then, extract the archive and place tbx.exe on the Desktop folder. The watermint toolbox can run from any path in the system if allowed by the system. But the instruction samples are using the Desktop folder. Please replace the path if you placed the binary other than the Desktop folder.

Usage

This document uses the Desktop folder for command example.

Run

Windows:

cd $HOME\Desktop
.\tbx.exe team runas sharedfolder batch leave -file /PATH/TO/DATA_FILE.csv

macOS, Linux:

$HOME/Desktop/tbx team runas sharedfolder batch leave -file /PATH/TO/DATA_FILE.csv

Note for macOS Catalina 10.15 or above: macOS verifies Developer identity. Currently, tbx is not ready for it. Please select “Cancel” on the first dialogue. Then please proceed “System Preference”, then open “Security & Privacy”, select “General” tab. You may find the message like:

“tbx” was blocked from use because it is not from an identified developer.

And you may find the button “Allow Anyway”. Please hit the button with your risk. At second run, please hit button “Open” on the dialogue.

Options:

Option Description Default
-file Path to data file  
-keep-copy Keep a copy of the folder’s contents upon relinquishing membership. false
-peer Account alias default

Common options:

Option Description Default
-auto-open Auto open URL or artifact folder false
-bandwidth-kb Bandwidth limit in K bytes per sec for upload/download content. 0 for unlimited 0
-budget-memory Memory budget (limits some feature to reduce memory footprint) normal
-budget-storage Storage budget (limits logs or some feature to reduce storage usage) normal
-concurrency Maximum concurrency for running operation Number of processors
-debug Enable debug mode false
-experiment Enable experimental feature(s).  
-extra Extra parameter file path  
-lang Display language auto
-output Output format (none/text/markdown/json) text
-proxy HTTP/HTTPS proxy (hostname:port). Please specify DIRECT if you want skip setting proxy.  
-quiet Suppress non-error messages, and make output readable by a machine (JSON format) false
-retain-job-data Job data retain policy default
-secure Do not store tokens into a file false
-verbose Show current operations for more detail. false
-workspace Workspace path  

File formats

Format: File

Member folder data

Column Description Example
member_email Member email address john@example.com
path Path to share /projects/my_project

The first line is a header line. The program will accept a file without the header.

member_email,path
john@example.com,/projects/my_project

Results

Report file path will be displayed last line of the command line output. If you missed command line output, please see path below. [job-id] will be the date/time of the run. Please see the latest job-id.

OS Path pattern Example
Windows %HOMEPATH%\.toolbox\jobs\[job-id]\reports C:\Users\bob.toolbox\jobs\20190909-115959.597\reports
macOS $HOME/.toolbox/jobs/[job-id]/reports /Users/bob/.toolbox/jobs/20190909-115959.597/reports
Linux $HOME/.toolbox/jobs/[job-id]/reports /home/bob/.toolbox/jobs/20190909-115959.597/reports

Report: operation_log

This report shows the transaction result. The command will generate a report in three different formats. operation_log.csv, operation_log.json, and operation_log.xlsx.

Column Description
status Status of the operation
reason Reason of failure or skipped operation
input.member_email Member email address
input.path Path to share
result.shared_folder_id The ID of the shared folder.
result.parent_shared_folder_id The ID of the parent shared folder. This field is present only if the folder is contained within another shared folder.
result.name The name of the this shared folder.
result.access_type The current user’s access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
result.path_lower The lower-cased full path of this shared folder.
result.is_inside_team_folder Whether this folder is inside of a team folder.
result.is_team_folder Whether this folder is a team folder.
result.policy_manage_access Who can add and remove members from this shared folder.
result.policy_shared_link Who links can be shared with.
result.policy_member Who can be a member of this shared folder, as set on the folder itself (team, or anyone)
result.policy_viewer_info Who can enable/disable viewer info for this shared folder.
result.owner_team_id Team ID of the folder owner team
result.owner_team_name Team name of the team that owns the folder
result.access_inheritance Access inheritance type

If you run with -budget-memory low option, the command will generate only JSON format report.

In case of a report become large, a report in .xlsx format will be split into several chunks like follows; operation_log_0000.xlsx, operation_log_0001.xlsx, operation_log_0002.xlsx, …

Proxy configuration

The executable automatically detects your proxy configuration from the environment. However, if you got an error or you want to specify explicitly, please add -proxy option, like -proxy hostname:port. Currently, the executable doesn’t support proxies which require authentication.

}