Skip to content

docs: Update Salesforce auth docs for Salesforce Spring '26 (External Client Apps)#920

Merged
matyas-jirat-keboola merged 2 commits into
mainfrom
docs/salesforce-external-client-app-spring-26
May 19, 2026
Merged

docs: Update Salesforce auth docs for Salesforce Spring '26 (External Client Apps)#920
matyas-jirat-keboola merged 2 commits into
mainfrom
docs/salesforce-external-client-app-spring-26

Conversation

@terezaskalova
Copy link
Copy Markdown
Contributor

@terezaskalova terezaskalova commented May 18, 2026

Jira issue(s): SUPPORT-16320

Changes:

  • Renamed "Connected App with Username and Password" → "External Client App with Username and Password" with updated step-by-step setup reflecting the new Salesforce Spring '26 UI (App Manager → New External Client App)
  • Renamed "Connected App OAuth 2.0 Client Credentials" → "External Client App OAuth 2.0 Client Credentials" with expanded steps including the required Run As user and Permitted Users policy configuration
  • Added backward-compatibility notes in both sections: existing Connected Apps from before Spring '26 continue to work unchanged
  • Fixed stale "Connected App methods" reference in Additional Settings → "External Client App methods"

Context: Salesforce Spring '26 (Jan/Feb 2026) removed the "New Connected App" button from App Manager. New integrations must use "New External Client App." The Keboola connector config fields (consumer_key, consumer_secret, domain) remain identical — no connector code changes needed.

Steps verified against: Salesforce blog post on ECAs, AuditForce step-by-step guide, Salesforce Trailhead ECA project, and Salesforce developer docs on Client Credentials + Run As user.

Items for reviewer to verify:

  • The "Distribution State → Local" step (step 4) — based on customer report; not all sources mention this explicitly in the basic flow
  • That the connector's username+password auth method works with ECAs — note that ECAs do not support the OAuth grant_type=password flow per Salesforce docs, but the connector may use a different grant type (e.g., device flow or auth code) under the hood
  • Anchor link #external-client-app-with-username-and-password in the CC section cross-reference resolves correctly in Jekyll — verified via local testing

Follow-up needed (not in this PR): keboola/component-salesforce-v2/README.md has the same outdated Connected App setup steps and needs a separate PR (kds-team-owned).

Previously updated in PR #858 (Dec 2025, pre-Spring '26).

Link to Devin session: https://app.devin.ai/sessions/05b283f4bb2c47889bee0ad70042d8bd
Requested by: @terezaskalova

…Client App

Salesforce Spring '26 removed the "New Connected App" button from App Manager.
New apps must be created as External Client Apps. Existing Connected Apps continue
to work. Updated both Connected App auth sections to reflect the new UI flow.

Related: SUPPORT-16320
Co-Authored-By: tereza.skalova <tereza.skalova@keboola.com>
@devin-ai-integration
Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@devin-ai-integration
Copy link
Copy Markdown
Contributor

@ZdenekSrotyr — requesting your review since you merged the previous Salesforce auth docs update in PR #858.

@matyas-jirat-keboola matyas-jirat-keboola marked this pull request as ready for review May 19, 2026 15:30
@matyas-jirat-keboola
Copy link
Copy Markdown
Contributor

@keboola-pr-reviewer review

keboola-pr-reviewer[bot]

This comment was marked as outdated.

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

Devin Review found 1 potential issue.

Open in Devin Review

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.

🚩 Incomplete terminology rename: "Connected App" reference remains in Additional Settings

Line 80 still reads (available for Security Token and Connected App methods) while all the section headers and descriptions in this PR were renamed from "Connected App" to "External Client App". This creates an inconsistency — a user reading the updated section headers won't find a method called "Connected App" anymore. This line wasn't touched by the diff, but it should be updated to match the new terminology (e.g., "External Client App methods").

(Refers to line 80)

Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

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.

Good catch — fixed in cf10a30. Updated "Connected App methods" → "External Client App methods" on line 80.

Copy link
Copy Markdown

@keboola-pr-reviewer keboola-pr-reviewer Bot left a comment

Choose a reason for hiding this comment

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

Verdict: needs_human (risk 3/5) · profile docs

This PR introduces substantive product-behaviour claims about Salesforce External Client App setup steps that require human verification.

Concerns:

  • components/extractors/marketing-sales/salesforce/index.md: PR body admits ECAs may not support password grant type, making the Username+Password section potentially incorrect guidance.
  • components/extractors/marketing-sales/salesforce/index.md: Heading renames break old anchor slugs; inbound links to #connected-app-with-username-and-password are now silently broken.
  • components/extractors/marketing-sales/salesforce/index.md: Step 4 ('Distribution State → Local') is flagged by the author as unverified — based on a customer report only.

Suggested reviewers: keboola/docs

Copy link
Copy Markdown
Contributor

@matyas-jirat-keboola matyas-jirat-keboola left a comment

Choose a reason for hiding this comment

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

LGTM

…enamed sections

Co-Authored-By: tereza.skalova <tereza.skalova@keboola.com>
@matyas-jirat-keboola matyas-jirat-keboola merged commit 6666bd8 into main May 19, 2026
1 check passed
@matyas-jirat-keboola matyas-jirat-keboola deleted the docs/salesforce-external-client-app-spring-26 branch May 19, 2026 15:49
jordanrburger added a commit that referenced this pull request May 22, 2026
Brings in everything merged on main since 2026-03-20 (PRs #888 through
#920), including:

- Telemetry: dashboards rewrite (#900-class), connector docs migrated to
  YAML+include (#896-class), new kbc_mcp_event table, alphabetical
  ordering, ER diagram viewer
- Data Apps: storage-access docs (#914, #910), backend-versions index
  rename, streamlit config.toml docs (#917), nav restructure
- Custom Python component docs (#888), Salesforce External Client App
  Spring '26 updates (#920), Governed Change Management (#918)
- Public-beta-warning refactor (now 2 instances total)

Sidebar regenerated with new entries. Telemetry-data Liquid loops are
now expanded via the new transform (50 tables rendered, 0 Liquid tags
left in the page).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants