Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure OAuth client credentials authentication

Learn how to configure OAuth client credentials authentication in Zuora Connector for Salesforce CRM to securely synchronize Zuora Billing data with Salesforce.

  • Ensure you are using Zuora Connector for Salesforce CRM version 5.24 or later.

  • Verify that you have administrator access to both Salesforce and Zuora.

  • Complete the configuration in a Salesforce Sandbox before applying it to Production.

  1. Create an external client app in Salesforce:
    1. Log in to your Salesforce Sandbox.
    2. Switch to Salesforce Lightning Experience and click Setup icon Setup.
    3. In the Quick Find box, search and click External Client App Manager.
    4. Click New External Client App.
    5. Enter the required Basic Information.
  2. Enable OAuth:
    1. Under API (Enable OAuth Settings), select Enable OAuth.
    2. In App Settings, enter the Callback URL.
      Note: Callback URL: https://localhost.com. Salesforce requires a callback URL for this setup, but the client credentials flow does not use the callback URL.
    3. Under OAuth Scopes, select Manage user data via APIs (api).
    4. Under Flow Enablement, select Enable Client Credentials Flow and click OK to confirm.
    5. Under Security, select Require secret for Web Server Flow, Require secret for Refresh Token Flow, and Require Proof Key for Code Exchange (PKCE) extension for Authorization Flow.
    6. Click Create.
  3. Configure OAuth policies:
    1. Salesforce displays the app policy overview, click Edit.
    2. Open Manage External Client Apps.
    3. Select the newly created client app and click Edit.
    4. Under OAuth Policies:
      • Enable Client Credentials Flow.

        In OAuth Policies, select Enable Client Credentials Flow.

      • In Run As (Username), assign the integration user that Zuora uses for authentication.
        Note: The integration user must have read and write access to all synced Salesforce objects and the installed Zuora configuration objects.It is also recommended to grant the user access to view current API usage.
    5. Click Save.
  4. Retrieve OAuth credentials:
    1. Navigate to the Settings tab, select OAuth Settings, and click Consumer Key and Secret.
    2. Copy the generated Consumer Key (Client ID), Consumer Secret (Client Secret), and Login URL. Securely save these credentials for entry into Zuora.
  5. Enter the credentials in Zuora:
    1. In Zuora Connector for Salesforce CRM, navigate to Authentication tab and select Client Credentials.
    2. Enter the following values:
      • Client ID = Salesforce consumer key

      • Client Secret = Salesforce consumer secret

      • Login URL = the Salesforce instance base login URL

  6. Validate the connection:
    1. In the Zuora Connector, click Validate Connection.
    2. Confirm that authentication succeeds in your Salesforce Sandbox environment.
    3. If the validation is successful, the OAuth configuration is complete.