Zuora Query and Zuora Bulk Query Authentication Guide

Zuora Query and Zuora Bulk Query Authentication Guide


Overview

This is a step-by-step guide to creating an OAuth entry, acquiring credentials and authorising the Zuora Query and Zuora Bulk Query connectors for use in Matillion ETL.

Important Information

  • The Zuora Query and Zuora Bulk Query connectors use either a username and password or an OAuth for third-party authentication. This guide will only explain the OAuth method.
  • 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 Zuora CRM Query or Zuora Bulk Query 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. Then, click ... next to the Authentication Method input.
    3. Select OAuth from the dropdown menu in the pop-up window and click OK.
    4. The Authentication input will now appear on the list of properties. Click ... next to it, 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 Zuora. 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 Zuora Central. The Zuora login screen will appear immediately. Enter valid login credentials to continue. The browser will then redirect to the Zuora Central dashboard. In the top right of the screen, click <Profile Name>Administration.

    Zuora Central dashboard

    Zuora Central dashboard

  2. On the Administration Settings window, click Managed Users. This will open a list of users.

    Administration Settings

    Administration Settings

  3. In the list of users, find and click on the user that will be associated with the app.

    Manage Users

    Manage Users

  4. Scroll to the bottom of the selected user's profile page to the New OAuth Client section. Enter a client name and description for the OAuth and click create.

    Create New OAuth Client

    Create New OAuth Client

  5. Lastly, copy the codes after Client ID and Client secret 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.
    Copy Client ID and Client Secret

    Copy Client ID and Client Secret


Authorising OAuth 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 Zuora Central earlier, provide details for the following fields:

    Configure OAuth settings

    Configure OAuth settings