OpenFn / OpenFn/docs

Add platform-specific integration user recommendations

Open
#742 7 comments 0 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
23
Forks
20
Avg merge
3d 1h
Merged PRs (30d)
6

Description

Summary

The Credentials page already recommends creating a dedicated integration user for OpenFn workflows, but it lacks concrete, platform-specific guidance. This issue tracks improving that section by cross-linking to existing Salesforce tips and adding new Google Service Account guidance.

Proposed changes
Salesforce — link to existing docs

The Salesforce adaptor page already covers:

  • Recommending a dedicated "openfn" integration user
  • Using the Salesforce API-only user license
  • A link to Salesforce's official documentation on configuring this

Action: Add a reference/link from the Credentials page integration user section pointing to the Salesforce adaptor page for platform-specific guidance, rather than duplicating content.

Google — new Service Account guidance

The Google adaptors (Sheets, Drive, Healthcare, etc.) currently have no equivalent integration user guidance.

Action: Add a Google Service Account sub-section, covering:

  • Recommend using a Google Service Account instead of a personal user OAuth credential for automated workflows.
  • Service accounts are designed for machine-to-machine access and do not require a human login.
  • The service account should be granted only the scopes/permissions required for the specific workflow (e.g., read-only access to Sheets if the workflow only reads data), following the principle of least privilege.
  • Link to Google's documentation on creating and managing service accounts.

This guidance could live either on the Credentials page and/or the relevant Google adaptor pages (Sheets, Drive, etc.), consistent with how the Salesforce guidance is structured.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.