skip to main content
DataDirect Cloud OAuth API
 

Try DataDirect Cloud Now

DataDirect Cloud OAuth API

With the OAuth API you can manage the OAuth Tokens for DataSources using OAuth Authentication, which, currently, only Google Analytics DataSources support. In some cases, you might want to configure multiple Google Analytics data sources using the same Google Analytics credentials. The DataDirect Cloud connectivity service gives you the ability to create an OAuth profile that can be shared between multiple data sources.
As an OEM, you can register your application/product by supplying your ClientId and ClientSecret, allowing you to brand your OAuth connection/permission.

Using a DataDirect Cloud Application

If you want to use DataDirect Cloud's OAuthApplicationId, the workflow process is as follows:
1. Get a list of the registered applications and their respective OAuthApplicationIds, using <base>/api/mgmt/oauthapps. This list always includes DataDirect Cloud applications.
2. Supply the following information to create the OAuthProfile and return an OAuthProfileId:
*a Name
*a RefreshToken
*the OAuthApplicationId
*an optional AccessToken
3. Attach the OAuthProfileId to your DataSources that use OAuth and use that Application's DataStore using the DataDirect Cloud user interface or DataSource Management API. Specify "OAuthProfileId": "<id>" in the options of the DataSource.

Using Your Own Application

If you want to use your own application, the workflow process is as follows:
1. Get a list of the registered applications and their respective OAuthApplicationIds, using <base>/api/mgmt/oauthapps. This list always includes DataDirect Cloud applications.
2. If necessary, register your application, using POST <base>/api/mgmt/oauthapps.
Provide the Name, the id of the DataStore, the ClientId, and the ClientSecret. This registers the application with DataDirect Cloud and returns an OAuthApplicationId.
3. Supply the following information to create the OAuthProfile and return an OAuthProfileId:
*a Name
*a RefreshToken
*the OAuthApplicationId
*an optional AccessToken
4. Attach the OAuthProfileID to your DataSources that use OAuth and use that application's DataStore using the DataDirect Cloud user interface or DataSource Management API. Specify POST "OAuthProfileId": "<id>".
* Getting started with the DataDirect Cloud OAuth API
* OAuthApplications Operations
* OAuthProfiles Operations