OAuth 2 (authorisation code)

To view this content in our official product documentation, click here.

Introduction

The OAuth 2 authorisation code flow requires a user (in this case, a Patchworks user, adding a connector instance for use in process flows) to log in to an authorisation server and grant permission for Patchworks to access the required data.

How it works

When a Patchworks user adds an instance of a connector and chooses to authenticate with OAuth 2 (authorisation code) they are directed to the authorisation server for a third-party service, where they log in and 'allow' requested access. A sample user journey for NetSuite is shown below:

Here, we:

1. Add an instance and confirm credentials.
2. Are redirected to NetSuite, where we log in.
3. Are presented with information about what access is being requested, and choose to proceed.
4. Return to the Patchworks connector page, where our new NetSuite instance is added and ready to use in process flows.

If you'd like more detailed information about how `OAuth 2 authorisation code` authentication works, there's some great background information on the Postman website.

Redirect URIs

When specifying redirect URIs for OAuth 2, the following values can be used:

Environment	URI
Production	https://app.wearepatchworks.com/oauth/authenticate

OAuth 2 (authorisation code) authentication examples

It can be useful to compare how existing connectors have been configured for OAuth 2 (authorisation code) authentication. The Patchworks marketplace includes many connectors that are configured to use this authentication type - a few examples are linked below:

Brightpearl

Google Pub Sub

Google BigQuery

Sage

Snowflake

You can install any of these for comparison.

Related information

• Configuring OAuth 2 authentication (authorisation code)