Set up an OAuth 2.0 HTTP connection

Kathyana Queeman
  • Updated

OAuth 2.0 documentation: Framework, Standard

OAuth 2.0 is an increasingly common server API authorization protocol. In fact, many built-in integrator.io connections already gain access via OAuth 2.0, and it has become required or preferred by providers like Google, eBay, and Microsoft.

You can select this option to connect to any OAuth 2.0-compliant app that does not have a standard integrator.io connection, or you can build your own OAuth 2.0 connection for a supported app and exercise finer control over each setting, as described below:

Contents

A. Set up an HTTP connection

Start establishing the universal, or generic, HTTP connection in either of the following ways:

  • Select Connections from the Resources menu.

    Next, click + Create connection at the top right. In the resulting Create source panel, select HTTP from the Application list, under the Universal connectors group.

  • While working in a new or existing integration, you can add an application to a flow simply by clicking Add source or Add destination/lookup. From the Application list, under Universal connectors, select HTTP.

  • After the HTTP Application is added, click the Connection setting’s + button to proceed.

B. Provide general HTTP connection settings

Name (required): Enter a clear and distinguishable name. Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

Application (required, non-editable): A reminder of the app you’re editing. 

Mode (required): Select one of the following options:

  • Cloud to connect to a publicly accessible server application
  • On-premise to connect to a server that is publicly inaccessible and has integrator.io agent installed on it

Agent (required, if On-premise selected for Mode; otherwise not displayed): Select an agent from the list. To connect to an on-premise application, integrator.io requires that an agent be installed on a networked computer. An agent is a small application that allows you to connect to data behind your firewall. When installing an agent, you will specify a unique access token, which then populates the Agent drop-down list. The installed agents connect to integrator.io and establish a reverse SSH tunnel, allowing secure communication without the need to whitelist integrator.io IP addresses in your firewall settings. A single agent can be used by multiple different connections.

C. Edit OAuth 2.0 settings

Continuing in the Create connection panel, select OAuth 2.0 for the Auth type. The settings then become specific to OAuth 2.0.

As with all universal API connections, the parameters are unique to the vendor’s conventions. Before proceeding, review the developer documentation and your account settings.

OAuth 2.0 client (required): Create a new OAuth 2.0 iClient resource or select from an existing list. To add an iClient and configure your credentials, click the plus (+) button. Click the edit ( Edit button ) button to modify a selected client. Be sure to give the client a recognizable name for use in any other connections.

iClient configurations. For more about iClients, see Create an iClient resource.

Scope (optional): List the scopes to grant access to authorization server requests. Separate multiple scopes with a space character, unless you are providing an alternative delimiter, below.

Override HTTP status code for auth errors (optional): Provide an alternate status code if the HTTP status code for auth errors returned by this app is not the standard 401. For example, for an API that returns a generic 400 status code, enter 400 and then specify the field in the HTTP response body that indicates auth errors.

Path to auth error field in HTTP response body (optional): If the API returns a field that contains auth errors in the HTTP response body, enter the JSON path to that field. For example, when an API returns the field errorMessage with the value Auth failed, then enter errorMessage as the path.

Override access token HTTP headers (optional): Enter a name and a value to replace default header values with custom values. In rare cases, it may be necessary to include custom HTTP headers with your API requests. The default content-type header value is application/x-www-form-urlencoded. 

Auth error values (optional): If you supplied a fail path above, enter the exact values that the API will return to indicate auth errors. Separate multiple values with commas.

D. Edit common HTTP settings

Additional HTTP settings are found in the other sections in the Create connection pane (optional sections are collapsed by default):

  • Application details (contains the required settings Base URI and Media type)
  • Nonstandard API rate limiter
  • How to test this connection?
  • Advanced

For complete documentation of these settings, see Fundamentals of HTTP connections.

E. Save, test, and continue

Once you have configured the OAuth 2.0 HTTP connection, you have a few options for continuing:

  • Save & continue – click this button to test the connection, commit the new connection so that it will be available to all integrations for your account (and applied to the current source or destination app, if you created it within a flow)
  • Close – click this link to exit connection creation without saving
  • Test connection – click this button to verify that your new connection is free of errors

When you test or save the connection, it is verified before continuing. If the connection fails, double-check the provided settings, and test again.

See also

Related articles

Comments

0 comments

Please sign in to leave a comment.