Configure OAuth Authentication

To ingest content from Dropbox, you must create a Dropbox application to represent the connector and then run the OAuth configuration tool to configure OAuth authentication.

To create a new Dropbox OAuth application

  1. Go to https://www.dropbox.com/developers/apps and click Create App.
  2. Enable Scoped Access.
  3. Choose whether the app should request access to a single dedicated folder (App folder) or access to the entire Dropbox (Full Dropbox). When you configure the connector, the value of the parameter FullDropboxAccess should correspond to the choice you make here.
  4. Type a name for the app.
  5. Specify a redirect URL.

    • To use the NiFi Ingest connector, the redirect URL must match the URL shown in the advanced configuration dialog of the NiFi processor. (In the NiFi web interface, right-click the processor and click Configure. Then click ADVANCED. You can find the redirect URL on the OAUTH SETUP tab).
    • To use the standard connector, the redirect URL must match the value of the RedirectUrl parameter in the OAuth tool configuration file, oauth_tool.cfg. The default value is http://localhost:7878/.
  6. Click Permissions and grant the following permissions:

    Permission Required For
    account_info.read  
    files.metadata.read  
    files.content.read  
    files.metadata.write Insert / Delete actions
    files.content.write Insert / Delete actions
    sharing.read Mapped Security
    team_info.read (Dropbox for Business)
    team_data.member (Dropbox for Business)
    team_data.team_space (Dropbox for Business)
    files.permanent_delete (Dropbox for Business) Delete action
    members.read (Dropbox for Business) Mapped Security
    groups.read (Dropbox for Business) Mapped Security

To configure OAuth authentication

  • To configure the NiFi Ingest connector

    1. In the NiFi web interface, right-click the processor and click Configure.
    2. Click ADVANCED, and complete the guided setup wizard. Then configure OAuth using the OAUTH SETUP tab.
  • To configure the standard connector

    1. Open the folder where you installed the connector.
    2. Open the file oauth_tool.cfg in a text editor.
    3. In the [Default] section, set any SSL or proxy settings that are required to access the repository:

      SSLMethod The version of SSL/TLS to use.
      ProxyHost The host name or IP address of the proxy server to use.
      ProxyPort The port of the proxy server to use.

      For example:

      SSLMethod=NEGOTIATE
      ProxyHost=10.0.0.1
      ProxyPort=8080
    4. In the [OAuthTool] section, set the following parameters:

      AppKey The application key that was provided when you set up the application to represent the connector.
      AppSecret The application secret that was provided when you set up the application to represent the connector.

      Do not modify the other parameters in this section.

    5. Open a command-line window and run the following command.

      oauth_tool.exe oauth_tool.cfg OAuthTool

      Your default web browser opens to the Dropbox web site. The web page asks you to log in and grant consent for the connector to access Dropbox.

    6. Log in and grant consent.

      The web page displays a message stating that the OAuth details have been successfully stored, and the OAuth tool creates the files oauth.cfg and oauth2_sites.bin. When you configure the connector, import the parameters from oauth.cfg into your task configuration. For more information about including parameters from another file, see Include an External Configuration File.

    7. You can now configure a task to retrieve data from Dropbox. See Retrieve Files from Dropbox or Retrieve Files from Dropbox for Business.