OAuth Connector [BETA]

Go to Product
This Node Is Deprecated — This node is kept for backwards-compatibility, but the usage in new workflows is no longer recommended. The documentation below might contain more information.

BETA note: This node is still work in progress. Later versions might change the functionality, configuration or structure of the created tables.

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 the acquired “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 Variable.
  5. Use the obtained 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:

This node is powered ScribeJava.

Options

Service
Select the OAuth service (see above for available options).
API Key
They 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.

Input Ports

This node has no input ports

Output Ports

Icon
Result of the authentication (token, …)

Popular Predecessors

  • No recommendations found

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.