Configure OAuth Authentication

You must configure OAuth authentication so that the connector can authenticate with Google Drive. Use one of the following procedures:

Retrieve Information from a single Google Drive

NOTE: There is no need to complete this procedure if you ran the OAuth configuration tool during the installation process.

To configure OAuth authentication

  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, specify any SSL or proxy settings necessary to connect to Google Drive:

    SSLMethod The version of SSL/TLS to use.
    ProxyHost The host name or IP address of the proxy server that the connector must use.
    ProxyPort The port of the proxy server that the connector must 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 by Google Drive when you set up an application to represent the connector.
    AppSecret The application secret that was provided by Google Drive when you set up an application to represent the connector.
    RedirectUrl The URL at which the OAuth tool runs. This must match the Redirect URL that you configured when you created the application to represent the connector.

    Do not modify the other parameters in this section.

  5. Open a command-line window and run oauth_tool.exe.

    Your default web browser opens to the Google Drive web site. The web page asks you to authorize the connector to access Google Drive.

  6. Authorize the application.

    The OAuth tool creates a file named oauth.cfg, which contains the parameters that the connector requires to authenticate with Google Drive.

    You can merge these parameters into the connector configuration file using the following syntax:

    [MyTask] < "oauth.cfg" [OAUTH]

    For more information about including parameters from another file, see Include an External Configuration File.

    The OAuth tool also prints the parameters it has set to the command-line window.

  7. You can now configure a task to retrieve data from Google Drive. See Use the Connector.

Retrieve Information from G Suite Users

When you created a service account for accessing information from G Suite users (see Before you Install the Connector), Google provided a JSON file. The file contains various properties, including private_key and client_email. You must use these properties with the OAuth configuration tool to produce an OAuth sites file that the connector requires to access the information from users in the G Suite domain. After you complete the following procedure, the JSON file is no longer required.

To configure OAuth authentication

  1. Open the folder where you installed the connector.
  2. Open the file oauth_tool.cfg in a text editor.
  3. In the [GoogleServiceAccount] section, find the parameter CustomJson.
  4. Replace the strings <client_email> and <private_key> with the corresponding property values from the JSON file provided by Google.
  5. From the command line, run the following command. The arguments to this command are the name of OAuth tool configuration file and the relevant section name:

    oauth_tool oauth_tool.cfg GoogleServiceAccount

    The OAuth tool creates (or modifies) the file oauth2_sites.bin, to store the private key encrypted against the specified SiteName. It also creates a file named oauth.cfg. This contains the configuration parameters required by the connector to authenticate with Google Drive. You can import the contents of this file into the connector's configuration file with the following syntax:

    [MyTask1] < "oauth.cfg" [OAUTH]

    For more information about including parameters from another file, see Include an External Configuration File.


_FT_HTML5_bannerTitle.htm