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

group folder list

Find folders of each group

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 information about your Dropbox files and folders
Dropbox Business: View your team group membership
Dropbox Business: View your team membership
Dropbox Business: View your Dropbox sharing settings and collaborators
Dropbox Business: View structure of your team’s and members’ folders
Dropbox Business: View basic information about your team including names, user count, and team settings

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 group folder list 

macOS, Linux:

$HOME/Desktop/tbx group folder list 

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
-folder-name Filter by folder name. Filter by exact match to the name.  
-folder-name-prefix Filter by folder name. Filter by name match to the prefix.  
-folder-name-suffix Filter by folder name. Filter by name match to the suffix.  
-group-name Filter by group name. Filter by exact match to the name.  
-group-name-prefix Filter by group name. Filter by name match to the prefix.  
-group-name-suffix Filter by group name. Filter by name match to the suffix.  
-include-external-groups Include external groups in the report. false
-peer Account alias default
-scan-timeout Scan timeout mode. If the scan timeouts, the path of a subfolder of the team folder will be replaced with a dummy path like TEAMFOLDER_NAME/:ERROR-SCAN-TIMEOUT:/SUBFOLDER_NAME. short

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  

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: group_to_folder

Group to folder mapping. The command will generate a report in three different formats. group_to_folder.csv, group_to_folder.json, and group_to_folder.xlsx.

Column Description
group_name Name of a group
group_type Who is allowed to manage the group (user_managed, company_managed, or system_managed)
group_is_same_team ‘true’ if a group is in same team. Otherwise false.
access_type Group’s access level for this folder
namespace_name The name of this namespace
path Path
folder_type Type of the folder. (team_folder: a team folder or in a team folder, shared_folder: a shared folder)
owner_team_name Team name of the team that owns the folder

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; group_to_folder_0000.xlsx, group_to_folder_0001.xlsx, group_to_folder_0002.xlsx, …

Report: group_with_no_folders

This report shows a list of groups in the team. The command will generate a report in three different formats. group_with_no_folders.csv, group_with_no_folders.json, and group_with_no_folders.xlsx.

Column Description
group_name Name of a group
group_management_type Who is allowed to manage the group (user_managed, company_managed, or system_managed)
member_count The number of members in the group.

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; group_with_no_folders_0000.xlsx, group_with_no_folders_0001.xlsx, group_with_no_folders_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.

}