Creating a Custom OAuth Application
Creating a Custom OAuth Application
CData embeds OAuth Application Credentials with CData branding that can be used when connecting to Exact Online via a desktop application or a headless machine. If you want to use the embedded OAuth application, all you need to do to connect is to:- set AuthScheme to OAuth,
- get and set the OAuthAccessToken, and
- set the necessary configuration parameters.
(For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Connecting to Exact Online".)
However, you must create a custom OAuth application to connect to Exact Online via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.
Custom OAuth applications are useful if you want to:
- control branding of the authentication dialog;
- control the redirect URI that the application redirects the user to after the user authenticates; or
- customize the permissions that you are requesting from the user.
Procedure
To create a custom OAuth application for use in a Desktop, Web, or Headless Machine auth flow, and obtain the appropriate connection properties:
- If you have not already done so, create an Exact Online developer account.
- Log into the App Center.
- Navigate to Manage Apps > Add a New Application.
- Enter a name for the application. This name will be displayed to users when they are prompted to grant permissions to connect.
- Set the Redirect URI:
- For connecting via either a Desktop or a Headless Machine, set the Redirect URI to https://oauth.cdata.com/oauth/.
- For connecting via the Web, set the Redirect URI to a page where you would like the user to be returned after they have granted your application permission to connect.
- Click Edit. The App Center displays your new application's client credentials, client Id, and client secret.
Set these OAuth credentials, plus Division and Region, before you connect.