OAuthServiceImpl
Many IDOL Ingest processors use OAuth authentication to connect to other systems. For example, an IDOL connector might use OAuth when connecting to a data repository or third-party API. OAuth authentication normally requires a redirect URL. After a user approves an access request, this endpoint receives an authorization code that can be used to gain access to the required data or resources.
The OAuthServiceImpl is a NiFi controller service that provides a suitable endpoint for all IDOL Ingest processors that need to provide an OAuth redirect URL. IDOL Ingest processors can provide their own redirect URLs but these include component names and version numbers, so you might need to update your OAuth applications when you upgrade your IDOL NiFi Ingest components. Using the OAuthServiceImpl, you can set up your OAuth applications with a common redirect URL that does not change.
When you configure OAuth authentication in an IDOL Ingest processor, use the guided setup wizard. When you select your OAuthServiceImpl controller service, the redirect URL displayed in the guided setup wizard and used for the OAuth Flow is changed to that of the server running within the OAuthServiceImpl.
Properties
Name | Default Value | Description |
---|---|---|
Listening Port | 7878 | The port to listen on for OAuth redirect requests. |
Hostname | The hostname to bind to. If not specified, will bind to all hosts. | |
SSL Context Service | The SSL Context Service to use to secure the server. If specified, the server accepts only HTTPS requests; otherwise, the server accepts only HTTP requests. | |
Max Request Header Size | 8192 | The maximum size of request headers to accept. |
Endpoint | The endpoint (URL) reported to IDOL NiFi components for OAuth redirect requests using this service. You might need to set this if NiFi is running behind a proxy. |