Reference

Authentication User Account

Description

No description available [API reference]

Instructions

To use OAuth authentication, firstly, you need to create OAuth application:

  1. Log into your DropBox account.
  2. Go to DropBox My Apps.
  3. Then press Create app button to create a new app: My OAuth apps in Dropbox
  4. Once a new page opens, select Scoped access option: Create OAuth app to get Dropbox REST API data
  5. Next, select Full Dropbox to access all files and folders or App folder to access specific folder's files and folders option.
  6. Continue by giving your app a name.
  7. Then check I agree to Dropbox API Terms and Conditions checkbox.
  8. Click Create app button.
  9. Once a new page opens, click Enable additional teams and Enable additional users buttons: Configure OAuth app in Dropbox
  10. Then copy App key and App secret and copy paste them into your favorite text editor (you will need them later).
  11. Proceed by setting a Redirect URI and clicking Add button.

    NOTE: If you don't have a working Redirect URI, you can use https://zappysys.com/oauth (it's safe).

  12. Then click on Permissions tab and select application scopes: Set OAuth app permissions in Dropbox
  13. Select all Individual Scopes and Team Scopes if you want to manage team data.
  14. Click Submit button.
  15. Now go to SSIS package or ODBC data source and in User Account authentication set these parameters:
  1. For ClientId field use App key value.
  2. For ClientSecret field use App secret value.
  3. For ReturnUrl field use Redirect URI value.
  • Done! Now you are ready to use Dropbox Connector!
    • NOTE: If you are planning to use your current data connection/token for automated processes, we recommend that you use a generic account for token generation when the login box appears (e.g. sales_automation@mycompany.com instead of bob_smith@mycompany.com). When you use a personal account which is tied to a specific employee profile and that employee leaves the company, the token may become invalid and any automated processes using that token will fail. Another potentially unwanted effect of using a personal token is incorrect logging; the API calls (e.g. Read, Edit, Delete, Upload) made with that token will record the specific user as performing the calls instead of an automated process.

    Parameters

    Parameter Required Default value Options
    Name: UseCustomApp

    Label: UseCustomApp

    Use your own app credentials or inbuilt app provided by ZappySys for ease of use. If you choose UseCustomApp=true then make sure to obtain your own ClientId and Secret using steps provided (Click [Steps to Configure] link found next to Authentication Type dropdown)     		YES True
    Name: ReturnUrl

    Label: ReturnUrl

    		 YES https://zappysys.com/oauth
    Name: ClientId

    Label: ClientId

    		 YES, if UseCustomApp, otherwise NO
    Name: ClientSecret

    Label: ClientSecret

    		 YES, if UseCustomApp, otherwise NO
    Name: Scope

    Label: Scope
    Name: RetryMode

    Label: RetryMode

    		 RetryWhenStatusCodeMatch
    Name Value
    None None
    RetryAny RetryAny
    RetryWhenStatusCodeMatch RetryWhenStatusCodeMatch
    Name: RetryStatusCodeList

    Label: RetryStatusCodeList

    		 429
    Name: RetryCountMax

    Label: RetryCountMax

    		 5
    Name: RetryMultiplyWaitTime

    Label: RetryMultiplyWaitTime

    		 True