Dropbox Extract Authentication Guide

Dropbox Extract Authentication Guide


Overview

This is a step-by-step guide to creating an OAuth entry, acquiring credentials and authorising the Dropbox Extract connector for use in Matillion ETL.

Important Information

  • The Dropbox Extract connector uses an OAuth for third-party authentication.
  • While connector properties may differ between Cloud Data Warehouses, the authentication process remains the same.

Creating an OAuth Entry in Matillion ETL

  1. In Matillion ETL, on the top left of the screen, click ProjectManage OAuth.

    Please Note

    If a Dropbox Extract connector has already been added to an Orchestration Job, the Manage OAuth window may also be accessed using the following method:

    1. Click the connector icon to open the Properties panel at the bottom of the screen.
    2. Click ... next to the OAuth input, and finally click Manage in the pop-up window.
    Project dropdown menu

    Project dropdown menu

  2. Copy the Callback URL in the field at the top of the window as this will be required in Acquiring Third-Party Credentials.

  3. Click + in the bottom left of the window to open the Create OAuth Entry window.

    New OAuth entry

    New OAuth Entry

  4. Click the Service dropdown menu and select Dropbox. Then, provide a name for the OAuth in the Name field and click OK.

    Create OAuth Entry window

    Create OAuth Entry window

  5. On returning to the Manage OAuth window, check the list of OAuths to ensure the new entry is listed.

    Please Note

    This entry is Not Configured. Configuration of the OAuth entry will be discussed in Authorising for use in Matillion ETL.

    OAuth Entry list

    New Entry listed on Manage OAuth window


Acquiring Third-Party Credentials

  1. Navigate to the Dropbox Developers portal. In the top right of the screen, click App console. The browser will then redirect to a login screen. Enter valid login credentials to continue.

    Dropbox Developers homepage

    Dropbox Developers portal

  2. Once logged in, the portal will open on the My apps page. From here, click create app.

    My apps

    My apps

  3. Next, the create a new app on the DBX platform page will open. In the Choose an API section, select Dropbox Business API. Then, in the Choose the type of access you need, choose what information Matillion ETL will need to access.

    Create a new app

    Create a new app

  4. Now, in the Name your app section, provide a descriptive name for the new app. Then, tick the checkbox below to agree to the Dropbox API Terms and Conditions and click Create app.

    Name the app

    Name the app

  5. The browser will then redirect to the app's newly created dashboard. In the Settings tab, copy the codes to the right of App key and App secret as they will be required in Authorising for use in Matillion ETL.

    Please Note

    • In order to copy the App secret, Show must first be clicked to make it visible.
    • Additionally, when copying the codes, some browsers may add a space to the end of the code. Watch out for this as it will cause the credentials to fail.
  6. Finally, in the Redirect URIs section, paste the Callback URL (copied from the Manage OAuth window in Matillion ETL earlier) into the field provided, then click Add.

    Copy the App key and secret, and paste the Callback URL

    Copy the App key and secret, and paste the Callback URL


Authorising for Use in Matillion ETL

  1. Return to the Manage OAuth window in Matillion ETL and click next to the previously created OAuth entry. This will open the Configure OAuth window.

    Manage OAuth

    Manage OAuth

  2. Using the codes copied from the Dropbox Developers portal earlier, provide details for the following fields:

    • Client ID – enter the App key
    • Client Secret – enter the App secret, then click Next

    Configure OAuth settings

    Configure OAuth settings

  3. The next window will have an Authorization link. Click the link to authorise Matillion ETL to use the acquired credentials.

    Authorization link

    Authorization link

  4. The browser will then redirect to a page prompting to allow access to the app's folder within Dropbox. Click Allow to confirm.

    Allow Dropbox account access

    Please Note

    Under certain conditions, a warning message may appear before this screen – for example, if the app only has a small number of users.

    Allow Dropbox account access

  5. If all is successful, the browser will return to Matillion ETL with a window stating, "Authorization Successful".

    OAuth Authorization successful

    OAuth Authorization successful