Member management commands

Information commands

Below commands are to retrieve information about team members.

Basic management commands

Below commands are for managing team member accounts. Those commands are for a bulk operation by a CSV file.

Member profile setting commands

Member profile commands are for bulk updating member profile information. If you need to update the members’ email addresses, use the ‘member update email command. The command 'member update email receives a CSV file to bulk update email addresses. If you need to update the member’s display name, use the ‘member update profile` command.

Member storage quota control commands

You can see existing member storage quota setting or usage by the member quota list and member quota usage command. If you need to update member quota, use the member quota update command. The command member quota update receives CSV input for bulk updating storage quota setting.

There are two types of commands available for suspending/unsuspending members. If you wanted to suspend/unsuspend a member one by one, please use member suspend or member unsuspend. Otherwise, if you want to suspend/unsuspend members through a CSV file, please use the member batch suspend or member batch unsuspend command.

Suspend/unsuspend a member

Directory restriction commands

Directory restriction is the Dropbox Business feature to hide a member from others. Below commands update this setting to hide or unhide members from others.

Group commands

Group management commands

Below commands are for managing groups.

Group member management commands

You can add/delete/update group members by the below commands. If you want to add/delete/update group members by CSV file, use group member batch add, group member batch delete, or group member batch delete.

Find and delete unused groups

There are two commands to find unused groups. The first command is group list. The command group list will report the number of members of each group. If it’s zero, a group is not currently used to adding permission to folders. If you want to see which folder uses each group, use the command group folder list. group folder list will report the group to folder mapping. The report group_with_no_folders will show groups with no folders. You can safely remove groups once if you check both the number of members and folders. After confirmation, you can bulk delete groups by using the command group batch delete.

Team content commands

Admins’ can handle team folders, shared folders or member’s folder content thru Dropbox Business API. Please be careful to use those commands. The namespace is the term in Dropbox API that is for manage folder permissions or settings. Folder types such as shared folders, team folders, or nested folder in a team folder, member’s root folder or member’s app folder are all managed as a namespace. The namespace commands can handle all types of folders, including team folders and member’s folder. But commands for specific folder types have more features or detailed information in the report.

Team folder operation commands

You can create, archive or permanently delete team folders by using the below commands. Please consider using teamfolder batch commands if you need to handle multiple team folders.

Team folder permission commands

You can bulk add or delete members into team folders or sub-folders of a team folder through the below commands.

Team folder & shared folder commands

The below commands are for both team folders and shared folders of the team. If you wanted to know who are actually uses specific folders, please consider using the command team content mount list. Mount is a status a user add a shared folder to his/her Dropbox account.

Team space commands

Command for team space.

Namespace commands

Team file request commands

Member file commands

Team shared link commands

The team shared link commands are capable of listing all shared links in the team or update/delete specified shared links.

Difference between team sharedlink cap and team sharedlink update

Commands team sharedlink update is for setting a value to the shared links. Commands team sharedlink cap is for putting a cap value to the shared links. For example: if you set expiry by team sharedlink update expiry with the expiration date 2021-05-06. The command will update the expiry to 2021-05-06 even if the existing link has a shorter expiration date like 2021-05-04. On the other hand, team sharedlink cap expiry updates links when the link has a longer expiration date, like 2021-05-07.

Similarly, the command team sharedlink cap visibility will restrict visibility only when the link has less protected visibility. For example, if you want to ensure shared links without password to the team only. team sharedlink cap visibility will update visibility to the team only when a link is public and has no password.

Example (list links):

List all public links in the team

tbx team sharedlink list -visibility public

Results are stored in CSV, xlsx, and JSON format. You can modify the report for updating shared links. If you are familiar with the command jq, then they can create CSV file directly like below.

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

List links filtered by link owner email address:

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

Example (delete links):

Delete all link that listed in the CSV file

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

If you are familiar with jq command, then they can send data directly from the pipe like below (pass single dash - to the -file option to read from standard input).

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

File lock

File lock commands are capable of listing current file locks or releasing file locks as admin.

File lock commands for members

File lock commands for team folders

Activities log commands

The team activities log commands can export activities log by a certain filter or perspective.

Connected applications and devices commands

The below commands can retrieve information about connected devices or applications in the team.

Other usecases

External ID

External ID is the attribute that is not shown in any user interface of Dropbox. This attribute is for keep a relationship between Dropbox and identity source (e.g. Active Directory, HR database) by identity management software such as Dropbox AD Connector. In case if you are using Dropbox AD Connector and you built a new Active Directory tree. You may need to clear existing external IDs to disconnect relationships with the old Active Directory tree and the new tree. If you skip clear external IDs, Dropbox AD Connector may unintentionally delete accounts during configuring to the new tree. If you want to see existing external IDs, use the member list command. But the command will not include external ID by default. Please add the option -experiment report_all_columns like below.

tbx member list -experiment report_all_columns

Data migration helper commands

Data migration helper commands copies member folders or team folders to another account or team. Please test before using those commands before actual data migration.

Team info commands

Paper commands

Legacy paper commands

Commands for a team’s legacy Paper content. Please see official guide more detail about legacy Paper and migration

Team admin commands

Below commands are for managing team admins.

Commands that run as a team member

You can run a command as a team member. For example, you can upload a file into member’s folder by using team runas file sync batch up.

Notes:

Dropbox Business commands require admin permissions to execute them. Auth tokens must not share with anyone, including Dropbox support.