The OAuth client authorization API may be used to grant client applications access to Hybrid Data Pipeline data sources using OAuth 2.0. With the OAuth client authorization API, you can register a client application with Hybrid Data Pipeline to generate a client ID and client secret. In its role as the Authorization Server, Hybrid Data Pipeline exchanges the client ID and client secret for an access token to authorize the client application and allow access to a data source. You can also use the API 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. For details, see Using OAuth 2.0 for authorizing client application access to Hybrid Data Pipeline data sources.

The following table summarizes the operations that can be carried out with the OAuth client authorization API.

Operation Request URL
Get list of OAuth registered applications GET https://<myserver>:<port>/api/mgmt/oauth/client/applications
Register OAuth application POST https://<myserver>:<port>/api/mgmt/oauth/client/applications
Get registered application by ID GET https://<myserver>:<port>/api/mgmt/oauth/client/applications/{id}
Update registered application by ID PUT https://<myserver>:<port>/api/mgmt/oauth/client/applications/{id}
Delete registered application by ID DELETE https://<myserver>:<port>/api/mgmt/oauth/client/applications/{id}
Reset client secret of application PUT https://<myserver>:<port>/api/mgmt/oauth/client/applications/{id}/reset
Get list of applications for which logged-in user has access GET https://<myserver>:<port>/api/mgmt/oauth/client/allowedapplications
Revoke access granted for the given application ID DELETE https://<myserver>:<port>/api/mgmt/oauth/client/allowedapplications/{id}
Generate access token and refresh token POST https://<myserver>:<port>/oauth2/token
Begin the authorization flow POST https://<myserver>:<port>/oauth2/authorize