Google: OAuth2 generic

This document contains instructions for creating a generic OAuth2 Google credential for use with custom operations.

Prerequisites

• Create a Google Cloud (opens in a new tab) account.

Set up OAuth

There are five steps to connecting your n8n credential to Google services:

1. Create a Google Cloud Console project.
2. Enable APIs.
3. Configure your OAuth consent screen.
4. Create your Google OAuth client credentials.
5. Finish your n8n credential.

Create a Google Cloud Console project

First, create a Google Cloud Console project. If you already have a project, jump to the next section:

Enable APIs

With your project created, enable the APIs you'll need access to:

Configure your OAuth consent screen

If you haven't used OAuth in your Google Cloud project before, you'll need to configure the OAuth consent screen (opens in a new tab):

1. Access your Google Cloud Console - Library (opens in a new tab). Make sure you're in the correct project.

   

2. Open the left navigation menu and go to APIs & Services > OAuth consent screen. Google will redirect you to the Google Auth Platform overview page.
3. Select Get started on the Overview tab to begin configuring OAuth consent.
4. Enter an App name and User support email to include on the Oauth screen. Select Next to continue.
5. For the Audience, select Internal for user access within your organization's Google workspace or External for any user with a Google account. Refer to Google's User type documentation (opens in a new tab) for more information on user types. Select Next to continue.
6. Select the Email addresses Google should use to contact you about changes to your project. Select Next to continue.
7. Read and accept the Google's User Data Policy. Select Continue and then select Create.
8. In the left-hand menu, select Branding.
9. In the Authorized domains section, select Add domain:
   • If you're using n8n's Cloud service, add n8n.cloud
   • If you're self-hosting, add the domain of your n8n instance.
10. Select Save at the bottom of the page.

Create your Google OAuth client credentials

Next, create the OAuth client credentials in Google:

1. Access your Google Cloud Console (opens in a new tab). Make sure you're in the correct project.
2. In the APIs & Services section, select Credentials (opens in a new tab).
3. Select + Create credentials > OAuth client ID.
4. In the Application type dropdown, select Web application.
5. Google automatically generates a Name. Update the Name to something you'll recognize in your console.
6. From your n8n credential, copy the OAuth Redirect URL. Paste it into the Authorized redirect URIs in Google Console.
7. Select Create.

Finish your n8n credential

With the Google project and credentials fully configured, finish the n8n credential:

1. From Google's OAuth client created modal, copy the Client ID. Enter this in your n8n credential.
2. From the same Google modal, copy the Client Secret. Enter this in your n8n credential.
3. You must provide the scopes for this credential. Refer to Scopes for more information. Enter multiple scopes in a space-separated list, for example:

   https://www.googleapis.com/auth/gmail.labels https://www.googleapis.com/auth/gmail.addons.current.action.compose
4. In n8n, select Sign in with Google to complete your Google authentication.
5. Save your new credentials.

Video

The following video demonstrates the steps described above:

Scopes

Google services have one or more possible access scopes. A scope limits what a user can do. Refer to OAuth 2.0 Scopes for Google APIs (opens in a new tab) for a list of scopes for all services.

n8n doesn't support all scopes. When creating a generic Google OAuth2 API credential, you can enter scopes from the Supported scopes list below. If you enter a scope that n8n doesn't already support, it won't work.

Troubleshooting

Google hasn't verified this app

Google Cloud app becoming unauthorized