skip to main content
Hybrid Data Pipeline API reference : Management API : OAuth API for configuring Hybrid Data Pipeline to authorize client applications
  

Try Now

OAuth API for configuring Hybrid Data Pipeline to authorize client applications

To support OAuth 2.0 authentication, you can register your application with Hybrid Data Pipeline.
The Client Application Registration API can be used to grant client applications access to Hybrid Data Pipeline data sources using OAuth 2.0 authentication. With the Client Application Registration API, you can register a client application with Hybrid Data Pipeline to generate a client ID and client secret. The client ID and client secret can then be used to generate tokens that enable applications to authenticate against Hybrid Data Pipeline with OAuth 2.0. You can also use the APIs to view a list of registered applications, reset client credentials, revoke access to a registered application, and otherwise manage client application access to Hybrid Data Pipeline data sources using OAuth 2.0.
The following table summarizes the operations that can be carried out with the set of APIs.
Operation
Request
URL
GET
https://<myserver>:<port>/api/mgmt/oauth/client/applications
POST
https://<myserver>:<port>/api/mgmt/oauth/client/applications
GET
https://<myserver>:<port>/api/mgmt/oauth/client/applications/{id}
PUT
https://<myserver>:<port>/api/mgmt/oauth/client/applications/{id}
DELETE
https://<myserver>:<port>/api/mgmt/oauth/client/applications/{id}
PUT
https://<myserver>:<port>/api/mgmt/oauth/client/applications/{id}/reset
GET
https://<myserver>:<port>/api/mgmt/oauth/client/allowedapplications
DELETE
https://<myserver>:<port>/api/mgmt/oauth/client/allowedapplications/{id}
POST
https://<myserver>:<port>/api/mgmt/oauth2/token
POST
https://<myserver>:<port>/api/mgmt/oauth2/authorize
* Get list of OAuth registered applications
* Register OAuth application
* Get registered application by ID
* Update registered application by ID
* Delete registered application by ID
* Reset client secret of registered application
* Get list of applications for which logged-in user has access
* Revoke access granted for the given application ID
* Generate access token and refresh token
* Authorize token