Creating External Client App For Service Board Sync
You can create an External Client App in your Salesforce org.
1. Log in to Salesforce with your valid credentials.
2. Go to > > >
3. Click New External Client App.
4. Provide the following details:
Basic Information fields for External Client App.
|
Field
|
Description
|
|---|---|
|
Fields marked with * are mandatory.
|
|
|
External Client App Name*
|
Enter a unique name for the External Client App. This name helps administrators identify the app in App Manager.
|
|
API Name*
|
Enter the API name used to reference the app programmatically. By default, the system derives this value from the app name by replacing spaces with underscores. Ensure that the API name is unique and uses
• only letters, numbers, and underscores
• starts with a letter
• does not include spaces
• does not end with an underscore
• does not contain consecutive underscores
|
|
Contact Email*
|
Enter an email address that Salesforce can use to contact you or your support team if needed. This email address is not shared with Salesforce admins who install the app.
|
|
Distribution State*
|
Select how the external client app is distributed.
• Choose Local to develop the app for use only in the current org.
• Choose Packaged to develop the app for packaging and distribution.
|
OAuth Settings for External Client App.
|
Field
|
Description
|
|---|---|
|
Fields marked with * are mandatory.
|
|
|
Enable OAuth
|
Select this checkbox to enable OAuth authentication for the external client app. OAuth must be enabled to allow secure, token-based access to Salesforce APIs.
|
|
Callback URL
|
Enter the URL that Salesforce redirects users to after successful authorization. For example: https://<your_tenant_domain>/oauth
|
|
OAuth Scopes
|
Select the following scopes from Available OAuth Scopes and move them to Selected OAuth Scopes.
• Access the identity URL service (id. profile, email, address, phone)
• Manage user data via APIs (api)
|
5. In the Flow Enablement section, select Enable Client Credentials Flow.
6. In the Security section, clear Require Proof Key for Code Exchange (PKCE) extension for Supported Authorization Flows option. Ensure that the Require secret for Web Server Flow and Require secret for Refresh Token Flow options are selected.
7. Click Create.
Configuring OAuth Policies
1. Go to > > >
2. Click to open the recently created External Client App.
3. In the Policies tab, click Edit.
4. In the OAuth Policies section, enable Enable Client Credentials Flow.
5. Set Run As (Username) to integration user. Ensure that the user has required permissions. For more information, see Appendix C: Access and Permissions.
6. Click Save.
Generating Client Credentials
1. Go to > > >
2. Click to open the recently created External Client App.
3. In the Policies tab, click Edit.
4. In the App Authorization section, set IP Relaxation field to Relax IP Restrictions.
5. Click Save.
Retrieving Client Credentials
1. Go to > > >
2. Click to open the recently created External Client App.
3. Click Settings tab.
4. Expand OAuth Policies section.
5. Click Consumer Key and Secret.
6. Verify the user identity.
7. Copy Consumer Key and Consumer Secret.
Related Topic