Skip to content

Add google service-accounts user guidance on credential page#777

Open
hunterachieng wants to merge 5 commits into
mainfrom
feature/142-platform-creds
Open

Add google service-accounts user guidance on credential page#777
hunterachieng wants to merge 5 commits into
mainfrom
feature/142-platform-creds

Conversation

@hunterachieng

@hunterachieng hunterachieng commented May 8, 2026

Copy link
Copy Markdown
Contributor

Short Description

Improved the Credentials page and Google Sheets/Drive adaptor docs with platform-specific integration user guidance, service account recommendations, and updated credential screenshots.

Closes #742

Details

Adds platform-specific integration user guidance to the Credentials page and relevant Google adaptor pages. The Credentials page now links out to Salesforce and Google Sheets for platform-specific advice rather than duplicating content.

The Google Sheets and Google Drive adaptor pages each gain a "Using a Google Service Account" section covering least-privilege scope recommendations and resource sharing, plus updated screenshots for both OAuth and access token credential types.

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to
know!):

  • I have used Claude Code
  • I have used another model
  • I have not used AI

You can read more details in our
Responsible AI Policy

Signed-off-by: Hunter Achieng <achienghunter@gmail.com>
Signed-off-by: Hunter Achieng <achienghunter@gmail.com>
Comment thread adaptors/googledrive.md Outdated
Comment thread adaptors/googledrive.md Outdated
## Authentication

Google Drive uses OAuth 2.0 access tokens for API authentication:
Google Drive supports two credential types in OpenFn: **OAuth2** and a raw **access token**.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hunterachieng this not accurate, the raw access token is the OAuth 2.0 access token, Please revert this back to

Google Drive uses OAuth 2.0 access tokens for API authentication:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mtuchi I checked how we can add credentials for Google Drive and it uses both OAuth and you can add a raw access token on the creds page

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hunterachieng yes it's true you can add raw credential with any adaptor not only googlesheet, Are you saying it's possible to create a long lived access token from google cloud console ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, the token only lives for 1 hour. Should I change and only focus on Oauth2?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hunterachieng Yes, i think the way it was before is fine, we can add a foot note saying If you need to test the adaptor locally you, you can generate a 1hour token using gcloud cli

Comment thread adaptors/googledrive.md Outdated

@mtuchi mtuchi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @hunterachieng i left some comments in googledrive adaptor can you work on those and see if also you the other adaptor need the same changes

Signed-off-by: Hunter Achieng <achienghunter@gmail.com>
@hunterachieng hunterachieng requested a review from mtuchi May 26, 2026 14:33
Comment thread adaptors/googledrive.md Outdated
Signed-off-by: Hunter Achieng <achienghunter@gmail.com>
@hunterachieng hunterachieng requested a review from mtuchi May 28, 2026 11:27
@mtuchi mtuchi changed the title Improve Credentials page with platform-specific integration user guidance Add platform-specific integration user guidance on credential page May 29, 2026
@mtuchi

mtuchi commented May 29, 2026

Copy link
Copy Markdown
Contributor

Pausing review, we might need to close this pr after all. I just found out that we don't support Service Account type of credential in our Google adaptors.

See my full comment here @hunterachieng #742 (comment)

@mtuchi mtuchi self-assigned this Jun 1, 2026
@mtuchi mtuchi changed the title Add platform-specific integration user guidance on credential page Add google service-accounts user guidance on credential page Jun 1, 2026

@mtuchi mtuchi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I need @hunterachieng to approve the changes on adaptor firsts before approving this pr
See OpenFn/adaptors#1682

@mtuchi

mtuchi commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Okay i just had a chat with Stu on Gmail service account blocker, There is a bit of complexity on setting up service account permissions to be able to use that type of credential with Gmail adaptor. So for next steps is creating a thorough documentation on supporting service accounts for each google adaptor and highlighting their caveats.

For example with gdrive and googlesheets, the service account needs to have access to the file or folder to be able to use the credential. As for gmail, It only work for google workspace and the workspace admin needs to assign specific permissions to the service account to be able to use the credential.

What i learned from our call is Google is very sensitive when it comes to sending email via an API. So we should keep this in mind when we have to send email using Gmail account especially for local deployments of OpenFn lightning

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Add platform-specific integration user recommendations

2 participants