Batch update member profiles (Irreversible operation)
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:
| Description |
|---|
| Dropbox for teams: View your team membership |
| Dropbox for teams: View and manage your team membership |
| Dropbox for teams: View basic information about your team including names, user count, and team settings |
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-2025 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
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.
This document uses the Desktop folder for command example.
Windows:
cd $HOME\Desktop
.\tbx.exe dropbox team member update batch profile -file /path/to/data/file.csv
macOS, Linux:
$HOME/Desktop/tbx dropbox team member update batch profile -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.
| Option | Description | Default |
|---|---|---|
-file |
Data file | |
-peer |
Account alias | default |
| Option | Description | Default |
|---|---|---|
-auth-database |
Custom path to auth database (default: $HOME/.toolbox/secrets/secrets.db) | |
-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 |
-output-filter |
Output filter query (jq syntax). The output of the report is filtered using jq syntax. This option is only applied when the report is output as JSON. | |
-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 |
-skip-logging |
Skip logging in the local storage | false |
-verbose |
Show current operations for more detail. | false |
-workspace |
Workspace path |
Data file for batch profile updates.
| Column | Description | Example |
|---|---|---|
| Email address of the account | john@example.com | |
| given_name | Given name of the account | John |
| surname | Surname of the account | Smith |
The first line is a header line. The program will accept a file without the header.
email,given_name,surname
john@example.com,John,Smith
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 |
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.email | Email address of the account |
| input.given_name | Given name of the account |
| input.surname | Surname of the account |
| result.email | Email address of user. |
| result.email_verified | Is true if the user’s email is verified to be owned by the user. |
| result.status | The user’s status as a member of a specific team. (active/invited/suspended/removed) |
| result.given_name | Also known as a first name |
| result.surname | Also known as a last name or family name. |
| result.display_name | A name that can be used directly to represent the name of a user’s Dropbox account. |
| result.joined_on | The date and time the user joined as a member of a specific team. |
| result.invited_on | The date and time the user was invited to the team |
| result.role | The user’s role in the team (team_admin, user_management_admin, support_admin, or member_only) |
| result.tag | Operation tag |
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, …