OAuth credentials for universal connectors

When you create universal connectors, you can use OAuth 2.0 to authenticate with vendor applications. 

Prerequisites

A a good knowledge of the OAuth authorization flow as implemented by the vendor application.

Before the credentials are added to Oomnitza

To set up the credentials securely and correctly, review the API documentation provided by the vendor application. If you have any questions, contact your server administrator.

Before you add the credentials in Oomnitza, ensure that you can provide the following information. To do this, you will need a good knowledge of the OAuth 2.0 flow as implemented by the vendor application.

Field in Oomnitza	Information retrieved from Vendor application and documentation
Add auth data to	How do you want to send the access token to be sent. In most cases, it is sent in the request header.
Header Prefix	Which prefix is added to the authorization header before the token. The default is Bearer.
Grant Type	What grant type, authorization code or client credentials, is used.
Auth URL	The URL of the authorization server for the vendor application to get the authorization code. Required when you select authorization code as the grant type.
Access Token URL	The URL of the authorization server for the vendor application to get the access token. Required when you select authorization code or client credentials as the grant type
Client ID and Client Secret	The client ID and secret that are issued when the vendor application is registered.
Scope	The scope of the access request. The scope determines which resources the token can access and what actions can be completed. The scope can consist of one or multiple space-delimited values.
Client Authentication	Whether the client credentials are sent in the basic Auth header or in the body of the API call.
Refresh Token URL	The URL for refreshing the access token.

Redirect URI

Ensure the redirect URI for OAuth 2.0 in the vendor application's administration console  is set to the Oomnitza redirect URI: https://generic-oauth2-proxy.oomnitza.com/oauth2/redirect_url.

Advanced configuration (optional)

Depending on the requirements of the API that you want Oomnitza to sync with, you might need to add additional headers or parameters for the types of header requests.

If the grant type is authorization code, you can add additional headers and parameters to the 

• Auth request
• Token request
• Refresh request

If the grant type is client credentials, you can add additional headers and parameters to the 

• Token request
• Refresh request 

Note
The Content-Type of all of the request headers is set to application/x-www-form-urlencoded.