Create an OAuth-Enabled External Client App
Configure External Client App Policies
Get Your Consumer Key
Previous Versions
The external client apps framework enables your off-platform app to request data from Salesforce APIs. To integrate your single-page app with Headless Identity APIs, create an external client app and configure its settings and access policies.
| Required Editions |
|---|
| Available in: both Salesforce Classic (not available in all orgs) and Lightning Experience |
| Available in: Enterprise, Unlimited, and Developer Editions |
As part of the external client app setup, you enable the Authorization Code and Credentials Flow. With this flow, you can set up headless login. Enabling this flow is also a prerequisite for enabling headless registration. You also define what Salesforce data your app can access with scopes and configure other security settings and access policies. And you define a callback URL, which you use as the redirect_uri parameter during headless flows.
After you create an external client app, you get a consumer key, or client_id. During headless flows, your app passes the consumer key to Salesforce to identify itself.
Create an OAuth-Enabled External Client App
Create your external client app for headless identity, add the required scopes, and enable the Authorization Code and Credentials flow at the app level.
Configure External Client App Policies
In a standard OAuth flow, users often see an approval page where they confirm that an external client app is allowed to access their Salesforce data. With headless identity flows, you don’t want to show users a Salesforce approval page. To preapprove access, configure OAuth policies on your external client app.
When you create an external client app, it generates a consumer key, also known as a client ID. This value allows Salesforce to identify your third-party app during headless identity flows. Learn how to get your consumer key so that you can use it when configuring headless flows.