Box Extract Authentication Guide

Box Extract Authentication Guide


Overview

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

Important Information

  • The Box Extract connector uses 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 corner of the screen, click ProjectManage OAuth.

    Please Note

    If a Box 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 Authentication 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 corner of the window to open the Create OAuth Entry window.

    New OAuth entry

    New OAuth Entry

  4. Click on the Service dropdown menu and select Box. 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 Box App portal. The Box login screen will appear immediately. Enter valid login credentials to continue. Then, on the Box dashboard, click Dev Console on the sidebar on the left of the screen.

    Box Dashboard

    Box Dashboard

  2. Then, on the My Apps dashboard, click the Create New App block.

    Please Note

    Alternatively, click Create New App in the top right of the window.

    My Apps dashboard

    My Apps dashboard

  3. The CREATE A NEW BOX APP page will open, prompting firstly to choose what type of app will be built. Select Custom App and click Next.

    Choose the type of app to be built

    Choose the type of app to be built

  4. Then, an authentication method will need to be chosen. Select Standard OAuth 2.0 (User Authentication) and click Next.

    Choose the Authentication Method

    Choose the Authentication Method

  5. Finally, provide a name for the app in the field provided and click Create App.

    Provide a name for the app

    Provide a name for the app

  6. If the details of the app are accepted, the next screen will appear with a banner stating, "Your app has been created". Click View Your App to open the newly created app's Configuration window.

    View your App

    View Your App

  7. In the OAuth 2.0 Credentials section, copy the codes from the Client ID and Client Secret fields, as they will be required in Authorising for use in Matillion ETL.

    Please Note

    • Make sure to copy the Client Secret right away as it will appear only once.
    • Additionally, when copying the codes, some browsers may add a space to the end of the string. Watch out for this as it will cause the credentials to fail.
  8. Next, in the OAuth 2.0 Redirect URI section, paste the Callback URL (copied earlier from the Manage OAuth window in Matillion ETL) into the Redirect URI field.

  9. Then, scroll down to the page to the Application Scopes section and tick the checkboxes next to the relevant scopes. Once complete, click Save Changes in the top right of the window.

    Copy Codes & Redirect URI

    Copy Codes & Redirect URI


Authorising for Use in Matillion ETL

  1. Return to the Manage OAuth window on 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 Box App portal earlier, provide details for the following fields:

    Configure OAuth settings

    Configure OAuth settings

  3. The next window will have a Authorization Link. Click on this link to authorise Matillion ETL to use the acquired credentials.

    Authorization Link

    Authorization Link

  4. The browser will redirect you to a Box screen requesting access to the account associated with the app. Click Grant access to Box to confirm.

    Grant access to Box account

    Grant access to Box account

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

    OAuth Authorization Successful

    OAuth Authorization Successful