The OAuth applications API may be used to create an OAuth application object. In conjunction with an OAuth profile object, an OAuth application object can be used to integrate Hybrid Data Pipeline as a client application for access to REST data stores (via the Autonomous REST Connector), Google Analytics, Google BigQuery, Microsoft Dynamics 365 apps, Salesforce-based data stores, and Snowflake.

The OAuth application object contains the information that identifies Hybrid Data Pipeline as a registered application with the data store. In a multitenant environment, an OAuth application object can be created for a tenant. When an OAuth application is created for the system tenant, it can be used by users in either the system tenant or a child tenant to create data sources on supported data stores. When an OAuth application is created for a child tenant, it can only be used by users in the child tenant to create data sources. Even though they will be able to view OAuth application objects that exist in child tenants, administrators who reside in the system tenant can only use the OAuth application object in the system tenant when creating their own data sources. An OAuth application object must be created for the system tenant to permit the creation of data sources by users, including administrators, in the system tenant.

The permissions required to create and modify OAuth application objects for data stores depend on the tenant in which the user resides and the tenants for which the user has administrative access. With the Administrator (12) permission, a user can create an OAuth application object in any tenant across the system. With the MgmtAPI (11) and OAuth (28) permissions, a user in the system tenant can create an OAuth application object for the system tenant. This user can also create OAuth application objects for tenants for which he or she has administrative access. With the MgmtAPI (11) and OAuth (28) permissions, a user in a child tenant can create an OAuth application object only in the tenant in which he or she resides.

The following table lists the operations that can be performed with the OAuth applications API.

Task Request URL
Retrieve OAuth applications GET https://<myserver>:<port>/api/mgmt/oauthapps
Create an OAuth application object POST https://<myserver>:<port>/api/mgmt/oauthapps
Retrieve an OAuth application object GET https://<myserver>:<port>/api/mgmt/oauthapps/{id}
Update an OAuth application object PUT https://<myserver>:<port>/api/mgmt/oauthapps/{id}
Delete an OAuth application object DELETE https://<myserver>:<port>/api/mgmt/oauthapps/{id}