Integrating Hybrid Data Pipeline as a client application with an OAuth 2.0 grant flow
- Last Updated: June 5, 2023
- 2 minute read
- Hybrid Data Pipeline
- Version 5.0
- Documentation
Integrating Hybrid Data Pipeline as a client application with an OAuth 2.0 grant flow
Creating OAuth application and profile objects
Data access may be provided by creating OAuth application and profile objects. This method is only supported for the authorization code grant. It maintains the authorization code grant's separation between the application verification process and the consent process. On the one hand, the application object holds the authorization URI, token URI, client ID, client secret, and scope. On the other hand, the profile object holds the access and refresh tokens provided by the data store upon consent. The following workflow describes this implementation.
- Administrator registers Hybrid Data Pipeline as a client application with the data store service.
- Administrator creates the OAuth application object.
- At the administrator's discretion, an administrator or standard user creates the OAuth profile object.
- When creating the Hybrid Data Pipeline data source, the user specifies the required OAuth application and profile objects.
Specifying OAuth parameters when creating the data source
Data access may be provided by entering OAuth information during the configuration of the Hybrid Data Pipeline data source. In this case, the user creating the data source must provide all the information required by the OAuth grant type. This may include the authorization URI, token URI, client ID, client secret, and scope, as well as access and refresh tokens. This information is all held in the data source definition. This implementation involves two general steps.
- Administrator registers Hybrid Data Pipeline as a client application with the data store service.
- When creating the Hybrid Data Pipeline data source, the user specifies OAuth parameters directly in the data source definition.