As a part of the data sync infrastructure, you must configure a Connected App in your salesforce org to generate client ID (consumer key) and client secret (consumer secret).

Prerequisites:

  • Callback URL of your Salesforce org: The callback URL is your domain URL (Setup > My Domain).

To create a connected app

  1. Log in to the salesforce portal as an administrator.
  2. Go to Setup. In the Quick Find box, Enter App Manager and click App Manager in the suggestions.The Lightning Experience App Manager page appears.
  3. Click New Connected App.
  4. Fill in the following details in the Basic Information section.

    FieldDescription
    Connected App NameEnter the connected app’s name, which displays in the App Manager and on its App Launcher tile. For example, RLSInstance.
    API NameThe API name is generated automatically based on the name of the Connected App.
    Contact EmailEnter the email address of the administrator managing the Connected App.
  5. Fill in the following details in the API (Enable OAuth Settings) section.

    Fields

    Description

    Enable OAuth Settings

    Select this to define the OAuth settings. When you enable this field, additional settings are displayed under the API (Enable OAuth Settings) section.

    Enable for Device Flow

    Select this to enable the connected app for an external application. 

    Callback URL

    Enter the callback URL. Based on the instance URL, the Callback URL is generated by default when you select the field Enable for Device Flow. For example, d6g000006vxxxxxx--rlpstg12.sandbox.my.salesforce.com. You can also add other URLs in separate lines. 

    Use Digital Signatures

    Leave this option unchecked.

    Selected OAuth Scope

    Select Full access (full) and move to Selected OAuth Scopes by clicking the Add arrow.

    Require Secret for Web Server Flow

    Select this to require the connected app to provide a consumer secret for authorization.

    Require Secret for Refresh Token Flow

    Select this option to include the connected app’s client secret in the authorization request of the refresh token flow. If you don’t select this option and a connected app sends the client secret in the authorization request, Salesforce still validates it.

    Enable Client Credentials Flow

    Select this option to let this connected app use the OAuth client credentials flow. 

    Enable Authorization Code and Credentials Flow

    Select this option to let this connected app use the Authorization Code and Credentials Flow. This flow is supported only for Experience Cloud users. 

    Introspect All Tokens

    Select this option to authorize a single connected app to introspect all access and refresh tokens within the entire org. As part of the authorization process, the authorization server validates, or introspects, the client app’s access token. If the access token is current and valid, the client app is granted access. For more information, see OpenID Connect Token Introspection.

    Enabling this option reduces repetitive token requests during each login, minimizing the need for multiple logins to Salesforce.

  6. Leave all other fields blank. Click Save.

Changes can take up to 10 minutes to take effect.

After you create a Connected App, the system generates a Consumer Key and Consumer Secret to enhance the security of your connected app. The consumer key serves as a unique identifier for the customer within the Salesforce system, while the consumer secret validates the ownership and authorization associated with the consumer key.

To capture Consumer Key and Consumer Secret

After you create a Connected App, the system generates a Consumer Key and Consumer Secret.

  1. Log in to the Salesforce portal as an administrator.
  2. Go to Setup. In the Quick Find box, Enter App Manager and click App Manager in the suggestions.
  3. Find the connected app, click , and then select View.
  4. Next to Consumer Key and Secret, click Manage Consumer Details.
    You’re prompted to verify your identity using one of your registered methods.
  5. In the Consumer Details section, click Copy next to Consumer Key and Consumer Secret and save them for future use.