OAuth Connector

Go to Product

This node supports OAuth 2.0 (RFC6749) and 1.0a (RFC5849) flows to authenticate with various APIs. The target group of this node are intermediate users with an understanding of OAuth fundamentals and developers. From a high-level perspective, this works as follows:

  1. Register an “application” at the service with which you want to authenticate (the steps for this depend on the actual service – have a look at the developer API documentation). If you’re asked for a “Callback URL”, enter “http://localhost:55931”. After completing this step, you should get a personal “API Key” and “API Secret” (the exact terminology might vary).
  2. Open the configuration of this node and select the appropriate “Service”. Enter the API Key and Secret which you received in the previous step into the corresponding fields.
  3. Click the Authorize button. A browser window will open and (unless you’re already logged into the service) ask for login credentials and permission to access the service. Once you have authenticated successfully, you will see an “Access granted” page in your browser which you can close and go back to KNIME.
  4. The dialog will show “Successfully received an access token”. Close the dialog and execute the node. The table which is created on node execution will contain the access token (and probably other information such as a refresh token, scope, and expiration info). For your convenience, this information is also available as Flow Variables. If, and only in case of OAuth 2.0, the service also returned a refresh token, the node will request a new access token when it is re-executed.
  5. Use the obtained access token and supply it to your nodes which access the REST API – we strongly recommend the rock-solid, battle-proof HTTP Retriever from Palladian. But other nodes, such as KNIME’s integrated REST client also work. Usually the token will be provided in an “Authorization” header, but this depends on the actual service – please refer to the documentation of the API you’re trying to access.

The following services are supported:

Any service you’d like to get added? Any questions or feedback about the currently supported services? Let us know at mail@palladian.ai

Options

Service
Select the OAuth service (see above for available options).
API Key
The API Key from the API you’re accessing.
API Secret
The API Secret from the API you’re accessing.
Scope (*)
Optionally specify a scope.
Authorize Access
Click to open browser and start authorization.
Clear Token
Clears the token and allows you to re-authorize.

Input Ports

This node has no input ports

Output Ports

Icon
Result of the authentication which includes the following columns, depending on whether you’re authorizing via OAuth 2.0 or 1.0a:
  • accessToken: The access token issued during authorization
  • refreshToken (OAuth 2.0): The refresh token, which can be used to obtain new access tokens (see here)
  • scope (OAuth 2.0): The scope, which can be different from the one requested
  • tokenType (OAuth 2.0): The type of the token (see here)
  • expiresIn (OAuth 2.0): The lifetime of the access token in seconds
  • expiredAt (OAuth 2.0): The date/time when the access token will expire
  • accessTokenSecret (OAuth 1.0a): The token shared-secret
  • rawResponse: The raw response string for the authentication request (this can be JSON or other formats)

Popular Predecessors

Popular Successors

Views

This node has no views

Workflows

Links

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.

Go to Product

Installation

To use this node in KNIME, install the extension Palladian for KNIME from the below update site following our NodePit Product and Node Installation Guide:

v5.3

A zipped version of the software site can be downloaded here.

Plugin provider: palladian.ws
Plugin version: 3.1.4.202409251212
On NodePit since: 2024-07-15
Last update: 2024-11-21
KNIME versions: Since v4.4
NodePit Exclusive Only available on NodePit

Deploy, schedule, execute, and monitor your KNIME workflows locally, in the cloud or on-premises – with our brand new NodePit Runner.

Try NodePit Runner!