Application Configuration in Zuora Portal for OAuth2 Account to use in Zuora

In this article

Zuora OpenAPI and Zuora REST Read Snaps use the Zuora Dynamic OAuth2 and Zuora OAuth2 accounts to access Zuora. For the OAuth2 account to function without any issue, ensure to create and configure an application corresponding to the account as explained in the steps below. These steps also contain information required to create/define a new OAuth2 account for using with this Snap Pack.

Create/Access Zuora Portal Application

  1. Log into the Zuora Portal.

  2. Create a new account: Portal Home > Customer Accounts > Create a New Account.
    (OR)
    Click Customer Accounts and then click View All Accounts.

Locate/Define Information Required to Create your Zuora OAuth2 Account

Specify the values (Client ID and Client Secret) required to create a new OAuth2 account connection. To create an OAuth client for a user:

  1. Log into the Zuora portal.

  2. Click your username at the top right and navigate to Administration > Manage Users.
    The Users page is displayed.

  3. Locate the user for whom you want to create an OAuth2 account, and check if the user’s status is active.

  4. Click the user’s First Name, Last Name, or User Name.

  5. In the OAuth Clients section, enter a name for the OAuth client. You can use the existing Client details if they are available.

  6. Click Create.
    Zuora application displays the Client ID and Client Secret for the OAuth client. Note the Client ID and Client Secret to generate OAuth tokens.

  7. Click OK.

To allow the OAuth client to write data using the REST API, you must be an administrator of your Zuora tenant that includes the API Write Access permission.

Generate your Zuora OAuth2 Tokens

After creating the client, you must generate an OAuth token. To generate OAuth token, you need the following parameters:

  • Client ID: The client ID that you have created in the previous step.

  • Client Secret: The client secret that you have created in the previous step.

  • OAuth2 Endpoint: The URL of the endpoint that authorizes the application.

  • OAuth2 Token: The URL of the endpoint that retrieves the token for an authenticated account.

You must make a call to obtain a token using the following procedure.

  1. Click Authorize
    You will be redirected to the login page of Zuora.

  2. Log into the application and accept the permissions.
    The Access token and the Refresh Token will be generated.

  3. Check the Auto-refresh token checkbox and save the account.


See Also