Skip to content

dropbox-file-sharedfolder-member-list.md

Latest commit

 

History

History
186 lines (126 loc) · 8.93 KB

dropbox-file-sharedfolder-member-list.md

File metadata and controls

186 lines (126 loc) · 8.93 KB
layout command
title Command `dropbox file sharedfolder member list`
lang en

dropbox file sharedfolder member list

List shared folder members

Lists all members of a shared folder with their access levels and email addresses.

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:

Auth scopes

Description
Dropbox: View basic information about your Dropbox account such as your username, email, and country
Dropbox: View your Dropbox sharing settings and collaborators

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 application.


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

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

This project is no longer actively maintained. For more details, see: https://github.com/watermint/toolbox/discussions/911

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 authorization code:
Enter the authorization 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 dropbox file sharedfolder member list

macOS, Linux:

$HOME/Desktop/tbx dropbox file sharedfolder member 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:

-base-path : Choose the file path standard. This is an option for Dropbox for Teams in particular. If you are using the personal version of Dropbox, it basically doesn't matter what you choose. In Dropbox for Teams, if you select home in the updated team space, a personal folder with your username will be selected. This is convenient for referencing or uploading files in your personal folder, as you don't need to include the folder name with your username in the path. On the other hand, if you specify root, you can access all folders with permissions. On the other hand, when accessing your personal folder, you need to specify a path that includes the name of your personal folder.. Options: root (Full access to all folders with permissions), home (Access limited to personal home folder). Default: root

-peer : Account alias. Default: default

Common options:

-auth-database : Custom path to auth database (default: $HOME/.toolbox/secrets/secrets.db)

-auto-open : Auto open URL or artifact folder. Default: false

-bandwidth-kb : Bandwidth limit in K bytes per sec for upload/download content. 0 for unlimited. Default: 0

-budget-memory : Memory budget (limits some feature to reduce memory footprint). Options: low, normal. Default: normal

-budget-storage : Storage budget (limits logs or some feature to reduce storage usage). Options: low, normal, unlimited. Default: normal

-concurrency : Maximum concurrency for running operation. Default: Number of processors

-debug : Enable debug mode. Default: false

-experiment : Enable experimental feature(s).

-extra : Extra parameter file path

-lang : Display language. Options: auto, en, ja. Default: auto

-output : Output format (none/text/markdown/json). Options: text, markdown, json, none. Default: 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 to skip setting proxy.

-quiet : Suppress non-error messages, and make output readable by a machine (JSON format). Default: false

-retain-job-data : Job data retain policy. Options: default, on_error, none. Default: default

-secure : Do not store tokens into a file. Default: false

-skip-logging : Skip logging in the local storage. Default: false

-verbose : Show current operations for more detail.. Default: false

-workspace : Workspace path

Results

Report file path will be displayed last line of the command line output. If you missed the 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: member

This report shows a list of members of shared folders. The command will generate a report in three different formats. member.csv, member.json, and member.xlsx.

Column Description
name The name of this shared folder.
path_lower The lower-cased full path of this shared folder.
is_inside_team_folder Whether this folder is inside of a team folder.
is_team_folder Whether this folder is a team folder.
access_type The current user's access level for this shared file/folder (owner, editor, viewer, or viewer_no_comment)
is_inherited True if the member has access from a parent folder
email Email address of user.
display_name A name that can be used directly to represent the name of a user's Dropbox account.
group_name Name of a group
invitee_email Email address of invitee for this folder

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

In case of a report becomes large, a report in .xlsx format will be split into several chunks like follows; member_0000.xlsx, member_0001.xlsx, member_0002.xlsx, ...