- 21 Jun 2022
- 3 Minutes to read
- Print
- DarkLight
Dropbox Module
- Updated on 21 Jun 2022
- 3 Minutes to read
- Print
- DarkLight
Module Details | |
Core or Github Module | Github |
Steps Exposed? | Yes |
Step Location | Integration > Dropbox |
Settings Location | N/A |
Prerequisites |
|
The Dropbox Module provides integration via API. Steps are provided that cover common requests when using Dropbox, such as accessing/downloading files, sharing specific folders, and deleting resources.
Example
This example will demonstrate how to configure the Dropbox module.
- Navigate to System > Integrations > OAuth > Providers. Right-click Dropbox and select Edit Provider Settings.
- On the Edit OAuth Provider window, configure the Token Request URL, Authorize URL, Callback URL, Default Consumer Key, and Default Consumer Secret Key. Click SAVE.
URL Example URL Token Request URL https://www.dropbox.com/oauth2/token Authorize URL https://www.dropbox.com/oauth2/authorize Callback URL http://[baseportalurl]/decisions/HandleTokenResponse - In Dropbox, the Default Consumer Key is the App and the Default Consumer Secret Key is the App Secret Key.
- Navigate to System > Integrations > OAuth > Tokens and click CREATE TOKEN.
- Enter a name for the Token, select Dropbox as the Provider, and click Request Token. A browser window will display and ask for permission access to connect.
- After allowing access click OK to close the Create and Store OAuth Credentials window.
Add Members to File
The Add Members to File step adds the specified email addresses access to a File stored on Dropbox.
Input Name | Description |
---|---|
Access Level | Sets the access level for the new user for the File. by default, this will be set to Viewer. |
Emails | The email address for the account being added |
File Path | The path of the file on Dropbox |
Add Members to Folder
The Add Members to Folder step adds the specified email addresses access to a Folder stored on Dropbox.
Input Name | Description |
---|---|
Access Level | Sets the access level for the new user to the Folder. by default, this will be set to Viewer. |
Emails | The email address for the account being added |
Folder Path | The path of the folder on Dropbox |
Create Folder
The Create Folder step adds creates a new folder within Dropbox.
Input Name | Description |
---|---|
New Folder Path | The Folder path in Dropbox for the new folder |
Create Shared Link
The Create Shared Link step adds creates a new link to a folder or file within Dropbox.
Input Name | Description |
---|---|
File or Folder Path | The File or Folder path in Dropbox to |
Delete Resource
The Delete Resource step removes the specified resource from Dropbox.
Input Name | Description |
---|---|
File or Folder Path | The path of the resource in Dropbox |
Does Resource Exist
The Does Resource Exist step check if the File or Folder exists in Dropbox.
Input Name | Description |
---|---|
File or Folder Path | The path to the resource in Dropbox |
Download File
The Download File step locates and downloads a File from Dropbox.
Input Name | Description |
---|---|
File Path | The file path within Dropbox |
Local Folder Path | The path that will store the downloaded file |
Get File List
The Get File List step retrieves a list of files for a folder within Dropbox.
Input Name | Description |
---|---|
Folder Path | The Folder path within Dropbox |
Get File Members
The Get File Members step retrieves a list of members who have access to the Resource.
Input Name | Description |
---|---|
File Path | The path to the file in Dropbox |
Get Folder List
The Get Folder List step retrieves a list of members that have access to the specified Folder in Dropbox.
Input Name | Description |
---|---|
Folder Path | The path to the resource within Dropbox |
Get Shared File Metadata
The Get Share File Metadata step retrieves the metadata for a file stored within Dropbox.
Input Name | Description |
---|---|
File Path | The path to the resource within Dropbox |
Get Shared Folder Metadata
The Get Share File Metadata step retrieves the metadata for a folder stored within Dropbox.
Input Name | Description |
---|---|
Folder Path | The path to the resource in Dropbox |
Remove Member from File
The Remove Member from File step removes the specified member's access to a File stored on Dropbox.
Input Name | Description |
---|---|
The email address for the member | |
File Path | The path to the file within Dropbox |
Remove Member from Folder
The Remove Member from Folder step removes the specified member's access to a Folder stored on Dropbox.
Input Name | Description |
---|---|
The email address for the member | |
Folder Path | The path to the resource in Dropbox |
Revoke Shared Link
The Revoke Shared Link step removes a shared link in Dropbox.
Input Name | Description |
---|---|
Shared Link (URL) | The URL address for the shared link within Dropbox |
Share Folder
The Share Folder step provides access to a Folder within Dropbox.
Input Name | Description |
---|---|
Folder Path | The path to the resource in Dropbox |
Unshare File
The Unshare File step adds removes the shared permissions for a File within Dropbox.
Input Name | Description |
---|---|
File Path | The path to the resource in Dropbox |
Unshare Folder
The Unshare Folder step adds removes the shared permissions for a Folder within Dropbox.
Input Name | Description |
---|---|
Folder Path | The path to the resource in Dropbox |
Upload File
The Upload File step creates a new file with the contents from a locally stored file.
Input Name | Description |
---|---|
Folder Path | The path of the resource in Dropbox |
Local File Path | The path of the locally stored File |