fix(docs): update Google OAuth credential docs (#4367)

Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
This commit is contained in:
Rowena Jones
2026-03-19 13:48:27 +01:00
committed by GitHub
parent db87042c3b
commit 81953e24f9
6 changed files with 36 additions and 16 deletions

View File

@@ -1,6 +1,6 @@
1. Log in to your [Google Cloud Console](https://console.cloud.google.com) using your Google credentials. 1. Log in to your [Google Cloud Console](https://console.cloud.google.com) using your Google credentials.
2. In the top menu, select the project dropdown in the top navigation and select **New project** or go directly to the [New Project](https://console.cloud.google.com/projectcreate) page. 2. In the top menu, select the project dropdown in the top navigation and select **New project** or go directly to the [New Project](https://console.cloud.google.com/projectcreate) page.
3. Enter a **Project name** and select the **Location** for your project. 3. Enter a **Project name** and select the location (**Organization** and/or **Parent resource**) for your project.
4. Select **Create**. 4. Select **Create**.
5. Check the top navigation and make sure the project dropdown has your project selected. If not, select the project you just created. 5. Check the top navigation and make sure the project dropdown has your project selected. If not, select the project you just created.

View File

@@ -1,10 +1,12 @@
/// note | Note for n8n Cloud users
For the following nodes, you can authenticate by selecting **Sign in with Google** in the OAuth section:
* [Google Calendar](/integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/index.md) * [Google Calendar](/integrations/builtin/app-nodes/n8n-nodes-base.googlecalendar/index.md)
* [Google Calendar Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.googlecalendartrigger.md)
* [Google Contacts](/integrations/builtin/app-nodes/n8n-nodes-base.googlecontacts.md) * [Google Contacts](/integrations/builtin/app-nodes/n8n-nodes-base.googlecontacts.md)
* [Google Docs](/integrations/builtin/app-nodes/n8n-nodes-base.googledocs.md)
* [Google Drive](/integrations/builtin/app-nodes/n8n-nodes-base.googledrive/index.md)
* [Google Drive Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.googledrivetrigger/index.md)
* [Google Mail](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md) * [Google Mail](/integrations/builtin/app-nodes/n8n-nodes-base.gmail/index.md)
* [Google Mail Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.gmailtrigger/index.md)
* [Google Sheets](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/index.md) * [Google Sheets](/integrations/builtin/app-nodes/n8n-nodes-base.googlesheets/index.md)
* [Google Sheets Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.googlesheetstrigger/index.md) * [Google Sheets Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.googlesheetstrigger/index.md)
* [Google Slides](/integrations/builtin/app-nodes/n8n-nodes-base.googleslides.md)
* [Google Tasks](/integrations/builtin/app-nodes/n8n-nodes-base.googletasks.md) * [Google Tasks](/integrations/builtin/app-nodes/n8n-nodes-base.googletasks.md)
///

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

View File

@@ -8,12 +8,13 @@ contentType: overview
This section contains: This section contains:
* [OAuth2 single service](/integrations/builtin/credentials/google/oauth-single-service.md): Create an OAuth2 credential for a specific service node, such as the Gmail node. * [OAuth2 single service](/integrations/builtin/credentials/google/oauth-single-service.md): Create an OAuth2 credential for a specific service node, such as the Gmail node. Two options exist:
* [OAuth2 generic](/integrations/builtin/credentials/google/oauth-generic.md): Create an OAuth2 credential for use with [custom operations](/integrations/custom-operations.md). * [Managed OAuth2](/integrations/builtin/credentials/google/oauth-single-service.md/#managed-oauth2): Sign in with Google directly on n8n, with no setup required on the Google Cloud Console. Available for n8n Cloud users only, for certain Google nodes.
* [Custom OAuth2](/integrations/builtin/credentials/google/oauth-single-service.md/#custom-oauth2): Configure an OAuth2 app in the Google Cloud Console and connect it to your n8n credential.
* [OAuth2 API (generic)](/integrations/builtin/credentials/google/oauth-generic.md): Create an OAuth2 credential for use with [custom operations](/integrations/custom-operations.md).
* [Service Account](/integrations/builtin/credentials/google/service-account.md): Create a [Service Account](https://cloud.google.com/iam/docs/service-account-overview) credential for some specific service nodes. * [Service Account](/integrations/builtin/credentials/google/service-account.md): Create a [Service Account](https://cloud.google.com/iam/docs/service-account-overview) credential for some specific service nodes.
* [Google PaLM and Gemini](/integrations/builtin/credentials/googleai.md): Get a Google Gemini/Google PaLM API key. * [Google PaLM and Gemini](/integrations/builtin/credentials/googleai.md): Get a Google Gemini/Google PaLM API key.
## OAuth2 and Service Account ## OAuth2 and Service Account
There are two authentication methods available for Google services nodes: There are two authentication methods available for Google services nodes:
@@ -21,6 +22,10 @@ There are two authentication methods available for Google services nodes:
* [OAuth2](https://developers.google.com/identity/protocols/oauth2): Recommended because it's more widely available and easier to set up. * [OAuth2](https://developers.google.com/identity/protocols/oauth2): Recommended because it's more widely available and easier to set up.
* [Service Account](https://cloud.google.com/iam/docs/understanding-service-accounts): Refer to the [Google documentation: Understanding service accounts](https://cloud.google.com/iam/docs/understanding-service-accounts) for guidance on when you need a service account. * [Service Account](https://cloud.google.com/iam/docs/understanding-service-accounts): Refer to the [Google documentation: Understanding service accounts](https://cloud.google.com/iam/docs/understanding-service-accounts) for guidance on when you need a service account.
### Managed OAuth2 for n8n Cloud users
[Managed OAuth2](/integrations/builtin/credentials/google/oauth-single-service.md/#managed-oauth2) is available for the following Google nodes, for n8n Cloud users. This provides a simplified credential creation process:
--8<-- "_snippets/integrations/managed-google-oauth.md" --8<-- "_snippets/integrations/managed-google-oauth.md"
## Compatible nodes ## Compatible nodes

View File

@@ -6,7 +6,7 @@ contentType: [integration, reference]
# Google: OAuth2 generic # Google: OAuth2 generic
This document contains instructions for creating a generic OAuth2 Google credential for use with [custom operations](/integrations/custom-operations.md). This document contains instructions for creating a generic Google OAuth2 API credential for use with [custom operations](/integrations/custom-operations.md).
--8<-- "_snippets/integrations/managed-google-oauth.md" --8<-- "_snippets/integrations/managed-google-oauth.md"

View File

@@ -9,13 +9,29 @@ priority: critical
This document contains instructions for creating a Google credential for a single service. They're also available as a [video](#video). This document contains instructions for creating a Google credential for a single service. They're also available as a [video](#video).
--8<-- "_snippets/integrations/managed-google-oauth.md"
## Prerequisites ## Prerequisites
* Create a [Google Cloud](https://cloud.google.com/) account. * Create a [Google Cloud](https://cloud.google.com/) account.
## Set up OAuth ## Managed OAuth2
n8n Cloud users can use **Managed OAuth2** for the following nodes:
--8<-- "_snippets/integrations/managed-google-oauth.md"
To use **Managed OAuth2**, just click **Sign in with Google** in the credentials screen. No more setup is required in the Google Cloud Console or elsewhere.
![Managed OAuth2 credentials screen](/_images/integrations/builtin/credentials/google/managed-oauth.png)
If you prefer to use Custom OAuth2, use the dropdown to change the authentication type.
## Custom OAuth2
Managed OAuth2 isn't available for self-hosted n8n users, nor for Google nodes not listed [above](#managed-oauth2). You must create a custom OAuth2 single service credential. This means creating an app in the Google Cloud Console and connecting it to n8n with a Client ID and Client Secret.
The rest of this document covers the full process.
## Set up Custom OAuth2
There are five steps to connecting your n8n credential to Google services: There are five steps to connecting your n8n credential to Google services:
@@ -67,18 +83,15 @@ Next, create the OAuth client credentials in Google:
1. Select **+ Create credentials** > **OAuth client ID**. 1. Select **+ Create credentials** > **OAuth client ID**.
1. In the **Application type** dropdown, select **Web application**. 1. In the **Application type** dropdown, select **Web application**.
1. Google automatically generates a **Name**. Update the **Name** to something you'll recognize in your console. 1. Google automatically generates a **Name**. Update the **Name** to something you'll recognize in your console.
1. **If you're self-hosting:** From your n8n credential, copy the **OAuth Redirect URL**. Paste it into the **Authorized redirect URIs** in Google Console. 1. From your n8n credential, copy the **OAuth Redirect URL**. Paste it into the **Authorized redirect URIs** in Google Console.
If you're using **n8n cloud**, you can leave this field empty as the OAuth setup is pre-configured, and the callback URL is fixed for that configuration.
1. Select **Create**. 1. Select **Create**.
### Finish your n8n credential ### Finish your n8n credential
With the Google project and credentials fully configured, finish the n8n credential: With the Google project and credentials fully configured, finish the n8n credential:
- If **self-hosted:**
1. From Google's **OAuth client created** modal, copy the **Client ID**. Enter this in your n8n credential. 1. From Google's **OAuth client created** modal, copy the **Client ID**. Enter this in your n8n credential.
1. From the same Google modal, copy the **Client Secret**. Enter this in your n8n credential. 1. From the same Google modal, copy the **Client Secret**. Enter this in your n8n credential.
- **If n8n cloud:**
1. In n8n, select **Sign in with Google** to complete your Google authentication. 1. In n8n, select **Sign in with Google** to complete your Google authentication.
1. **Save** your new credentials. 1. **Save** your new credentials.