You can authenticate to the Zuora via the OAuth 2 mechanism. The adapter uses the client_credential grant type, which means that only the OAuthClientId and OAuthClientSecret are needed to generate a token.

This is done via a single HTTP request, without the need of opening any login prompt.

Create an App

You must first create an OAuth client in the Zuora UI. To do this, you must be an administrator of your Zuora tenant.

This is a one-time operation.

• In your Zuora tenant, select Administration > Manage Users from the Profile & Settings menu, then create a user. Apps that use OAuth to authenticate to your Zuora tenant will perform actions as this user. Zuora recommends that you create an API user specifically for this purpose.
• On the Users page in your Zuora tenant, select the user you created in the previous step, then create an OAuth client for the user.
• Note the Client Id and Client secret for future use.

Authenticate to Zuora

After setting the following connection properties, you are ready to connect:

• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken connection property.
• OAuthClientId: Set this to the Client Id in your app settings.
• OAuthClientSecret: Set this to the Client Secret in your app settings.
• Tenant: Set this to your Zuora tenant. Possible options are: USProduction,USAPISandbox,USPerformanceTest,EUProduction,EUSandbox. By default we use USProduction tenant.
• URL: This is required only in case you have a US Production Copy environment. If this proprty is provided, the value of Tenant property has no effect in authentication process.

When you connect, the adapter completes the OAuth process.

1. Exchanges the OAuthClientId and OAuthClientSecret for the OAuthAccessToken.
2. Refreshes the access token when it expires.
3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.