This feature lets you authenticate callouts using an OAuth 2.0 provider. This article describes how to manage OAuth 2.0 providers.
This feature is in Limited Availability and available only to certain customers. We are currently not accepting access to this feature.
Working With OAuth 2.0
The general workflow for working with OAuth 2.0 in Zuora is as follows:
- Add a new OAuth 2.0 provider.
- Get and test a token.
- Enable the provider for use with Zuora callouts.
Managing OAuth 2.0 Providers
In order to implement OAuth 2.0 providers, follow these steps:
- Go to Settings > Administration Settings.
- Click Manage OAuth 2.0 Providers.This page shows all OAuth 2.0 providers available to you.
- Click new oauth2 provider.
- Enter the requested information.
Use a unique name. You can use a meaningful name to specify individual OAuth 2.0 providers.
Only Client Credentials is currently allowed.
Enter the client id that you got from your OAuth 2.0 provider.
Enter the client secret that you got from your OAuth 2.0 provider.
Access Token EndPoint
The URL used to get the access token for the given Client ID and Client Secret.
The URL used to revoke the access token.
The URL used to test the access token.
The value of the scope parameter is expressed as a list of space or comma separated, case sensitive strings. The strings are defined by the authorization server.
Enable OAuth 2.0 Provider for Callouts
- Go to Settings > Z-Billing Settings > Setup Profiles, Notifications, and Email Templates.
- Add a new notification or edit an existing notification.
- Select OAuth 2.0 for the Callout Authentication.
- Choose an OAuth 2.0 provider from the dropdown list.
- Click save.
View OAuth 2.0 Provider Details
- On the Manage OAuth 2.0 Providers page, click on the name of the provider that you want to see the details for.
- If you want to get a token, click obtain token.
- If you want to refresh your token, click refresh token.
- Once you have a token, you can test the token by clicking test token if the test token URL is provided.
- If you want to revoke a token, click revoke token if the revoke token URL is provided.
Delete an OAuth 2.0 Provider
On the Manage OAuth 2.0 Providers page, click Del on the same line as the provider that you want to delete. Note that you cannot delete an OAuth 2.0 provider that is being used by any Zuora callout notifications.