Google: Service Account

Using service accounts is more complex than OAuth2. Before you begin:

• Check if your node is compatible with Service Account.
• Make sure you need to use Service Account. For most use cases, OAuth2 is a better option.
• Read the Google documentation on Creating and managing service accounts.

Prerequisites

• Google Cloud account
• Google Cloud Platform project

Set up Service Account

Create a new credential in n8n

1. Follow the steps to Create a credential.

   Generic and specific credentials

   If you create a credential by selecting Create new in the credentials dropdown in a node, n8n automatically creates the correct credential type for that node. If you select Credentials > New, you must browse for the credential type:

   • To connect with a specific service, using resources and operations supported by n8n, choose that service. For example, to create a credential for use in the Gmail node, search for Gmail.
   • To create a credential for a custom API call, select Google API.

2. Note the Private Key from the node credential modal. You'll need this in the next section.

Set up service account in Google Cloud

In your Google Cloud Console dashboard:

1. Select the hamburger menu > APIs & Services > Credentials. Google takes you to your Credentials page.

   View screenshot

   

2. Select + CREATE CREDENTIALS > Service account.

   View screenshot

   

3. Enter a name in Service account name and an ID in Service account ID. Refer to Creating a service account for more information.

4. Select CREATE AND CONTINUE.
5. Based on your use-case, you may want to Select a role and Grant users access to this service account using the corresponding sections.
6. Select DONE.
7. Select your newly created service account under the Service Accounts section. Open the KEYS tab.

8. Select ADD KEY > Create new key.

   View screenshot

   

9. In the modal that appears, select JSON, then select CREATE. Google saves the file to your computer.

10. Enable each Google service API that you want to use:

    1. Access your Google Cloud Console - Library. Make sure you're in the correct project.

    2. Search for and select the API(s) you want to enable. For example, for the Gmail node, search for and enable the Gmail API.

       Some integrations need additional APIs

       The following integrations require the Google Drive API, as well as their own API:

       • Google Docs
       • Google Sheets
       • Google Slides

    3. Select ENABLE.

Create and test your connection

In n8n:

1. In the Service Account Email field, enter the email associated with your new Service Account (you can find this in the Details tab in Google Cloud).
2. Enter the Private Key from the downloaded JSON file. If you're running an n8n version older than 0.156.0: replace all instances of \n in the JSON file with new lines.
3. Optional: Click the toggle to enable Impersonate a User and enter the email.
4. Save your credentials.

The following video demonstrates the steps described above.

Troubleshooting

Service Account can't access Google Drive files

A Service Account can't access Google Drive files and folders that weren't shared with its associated user email.

1. Access your Google Cloud Console and copy your Service Account email.
2. Access your Google Drive and go to the designated file or folder.
3. Right-click on the file or folder and select Share.
4. Paste your Service Account email into Add People and groups.
5. Select Editor for read-write access or Viewer for read-only access.