Configuring Connected Apps

configuring-connected-apps: Salesforce Connected Apps & External Client Apps

Use this skill when the user needs OAuth app configuration in Salesforce: Connected Apps, External Client Apps (ECAs), JWT bearer setup, PKCE decisions, scope design, or migration from older Connected App patterns to newer ECA patterns.

Scope

In scope:

• .connectedApp-meta.xml or .eca-meta.xml files
• OAuth flow selection and callback / scope setup
• JWT bearer auth, device flow, client credentials, or auth-code decisions
• Connected App vs External Client App architecture choices
• Consumer key / secret / certificate handling strategy

Out of scope — delegate elsewhere:

• Configuring Named Credentials or runtime callouts → building-sf-integrations
• Deploying metadata to orgs → deploying-metadata
• Writing Apex token-handling code → generating-apex

First Decision: Connected App or External Client App

Default guidance:

• Choose ECA for new regulated, packageable, or automation-heavy solutions.
• Choose Connected App when simplicity and legacy compatibility matter more.
• Spring '26 note: creation of new Connected Apps is disabled by default in orgs. For new integrations, prefer External Client Apps unless Connected App compatibility is explicitly required.

Required Inputs

Ask for or infer:

• App type: Connected App or ECA
• OAuth flow: auth code, PKCE, JWT bearer, device, client credentials
• Client type: confidential vs public
• Callback URLs / redirect surfaces
• Required scopes
• Distribution model: local org only vs packageable / multi-org
• Whether certificates or secret rotation are required

Workflow

1. Choose the app model

Decide whether a Connected App or ECA is the better long-term fit using the decision table above.

2. Choose the OAuth flow

3. Start from the right template

Read the appropriate template before generating — do not build from scratch:

If you need source-controlled ECA OAuth security metadata, retrieve it from an org first and treat the retrieved file as the schema source of truth:

sf project retrieve start --metadata ExtlClntAppOauthSecuritySettings:<AppName> --target-org <alias>

4. Apply security hardening

Read references/security-checklist.md for the full 120-point security checklist. Favor:

• Least-privilege scopes
• Explicit callback URLs
• PKCE for public clients
• Certificate-based auth where appropriate
• Rotation-ready secret / key handling
• IP restrictions when realistic and maintainable

5. Validate deployment readiness

Read references/testing-validation-guide.md before handoff. Confirm:

• Metadata file naming is correct (see Gotchas below)
• Scopes are justified
• Callback and auth model match the real client type
• Secrets are not embedded in source

6. Handle errors

If deployment fails, check the error output for:

• DUPLICATE_VALUE — a Connected App or ECA with this name already exists; rename or retrieve-then-update instead
• INVALID_CROSS_REFERENCE_KEY — the externalClientApplication name in an ECA settings file doesn't match the .eca-meta.xml filename exactly
• INSUFFICIENT_ACCESS_OR_READONLY — user lacks the "Manage Connected Apps" permission
• If any step fails, do not proceed to the next step — surface the error to the user with the specific message above

Rules / Constraints

Metadata Notes That Matter

Connected App

Default source location (verify via sfdx-project.json → packageDirectories):

• <packageDir>/connectedApps/

External Client App

ECA metadata spans multiple top-level source directories. Default locations (verify via sfdx-project.json):

Gotchas

Output Expectations

When finishing, confirm and report in this order:

1. App type chosen — Connected App or External Client App
2. OAuth flow chosen
3. Files created or updated — list each metadata file path
4. Security decisions — scopes, PKCE, certs, secrets, IP policy
5. Next deployment / testing step

Suggested output shape:

App: <name>
Type: Connected App | External Client App
Flow: <oauth flow>
Files: <paths>
Security: <scopes, PKCE, certs, secrets, IP policy>
Next step: <deploy, retrieve consumer key, or test auth flow>
Score: <x>/120

Cross-Skill Integration