Prerequisites for Creating a Connection

You must satisfy the following prerequisites to create a connection with the Salesforce REST Adapter.

Obtain the Salesforce Domain URL

  1. Log in to the Salesforce sandbox instance.
  2. Find the domain name by performing the following steps:
    1. Go to your profile name.
    2. Select Set up.
    3. In the Quick find search field, enter Domain.
    4. Select My Domain from the Domain Management list.
    5. In the My Domain Settings page, copy the value for the Current My Domain Name URL.
    6. Append https:// to the domain name URL to complete the Salesforce domain URL.
      For example , if your Current My Domain Name URL value is yourDomain.my.salesforce.com, this is the complete Salesforce domain URL:
      https://yourDomain.my.salesforce.com/

Obtain the Current Salesforce API Version

  1. Log in to the Salesforce sandbox instance.
  2. Click Setup in the header or click your user name, then select Setup. See Explore the Salesforce Setup Menu.
  3. Search for API in the Quick Find field, then select API under Develop.
  4. Click Generate Enterprise WSDL.
  5. On the Generate Enterprise WSDL page, click Generate. The WSDL opens in a new browser tab and your current API version appears in the Commented-out section. For example:
    Salesforce.com Enterprise Web Services API Version 35.0

Note:

If you're using the Lightning Experience UI on your Salesforce instance, switch to the Salesforce Classic UI. See Toggle or switch between Lightning Experience and Salesforce Classic.

To learn more, visit Find your current API version.

Configuring OAuth – External Client App in Salesforce

Follow these steps to configure the OAuth - External Client App.

  1. Log in to your Salesforce account (Enterprise, Unlimited, or Developer Edition) and switch to Lightning Experience.
  2. Click Setup (gear icon in the header).
  3. In the Quick Find field, search for External Client App, and select External Client App Manager.
  4. Click New External Client App.
  5. On the New External Client App page, enter the required details under Basic Information, and enable OAuth Settings.
  6. Configure the OAuth Settings.
    1. Obtain the client ID and client secret from Consumer Key and Secret.
    2. Enter the callback URL:
      https://your_server/icsapis/agent/oauth/callback
    3. Select the following OAuth scopes:
      • Access and manage your data (api)
      • Access your basic information (id)
      • Perform requests on your behalf at any time (refresh_token)

      These scopes (api, id, and refresh_token) are the minimum required to configure a connection in Oracle Integration using the OAuth 2.0 Authorization Code Credentials security policy.

  7. Enable the following OAuth flows:
    • Client Credentials Flow
    • Authorization Code and Credentials Flow
  8. Configure the security settings as follows:
    1. Enable Require secret for Web Server Flow.
    2. Enable Require secret for Refresh Token Flow.
    3. Ensure PKCE is disabled (unchecked).
  9. Click Save and Continue to save the configuration.
  10. After saving, configure the Client Credentials Flow policies for the External Client App.

Configure Client Credential Flow Policies for External Client Apps

  1. Navigate to the Policies tab of your newly-created external client app, expand the OAuth Policies drop-down list, and click Edit.
  2. Enable Client Credentials Flow.

    To allow Salesforce to return access tokens, you must select an execution user for the flow. This user must have the API Only User permission.

  3. Set Run As to select the user to which you want to assign the client credentials flow.
  4. Click Save.

Obtain the Client ID and Client Secret

Follow these steps to retrieve the client ID (consumer key) and client secret from Salesforce.

  1. Log in to your Salesforce account (Enterprise, Unlimited, or Developer Edition) and switch to Lightning Experience.
  2. Click Setup (gear icon in the header).
  3. In the Quick Find field, search for External Client App.

    Note:

    If you do not have an External Client App, you can create a one. See Configuring OAuth – External Client App in Salesforce.
  4. Select External Client App Manager.
  5. From the list, select your External Client App.
  6. Go to the Settings tab.
  7. Under App Settings, click Consumer Key and Secret.
  8. Copy the client ID (consumer key) and client secret.

Create an External Client App from a Connected App

Use the automated process to create External Client Apps that replace your existing locally-connected apps. After migration, the old, connected app remains as a read-only version in App Manager.

  1. From Setup, in the Quick Find box, enter App Manager, and then select App Manager.
  2. Open the connected app by clicking the name. If the connected app is eligible for migration, the Migrate to External Client App button is available.
  3. Click Migrate to External Client App.
  4. Confirm that the app is local and that it doesn’t use the username-password flow.
  5. Click Migrate.

    A window opens with a link to the new External Client App.

Select Entities for Change Data Capture Events

To receive notifications using change data capture (CDC) events, you must select the entity/entities. Once selected, these objects are displayed for use on the Operations page of the Adapter Endpoint Configuration Wizard when configuring the Salesforce REST Adapter as a trigger connection.

  1. Navigate to Setup.
  2. Search for Change Data Capture in the Quick Find field, then select Change Data Capture.
  3. Select the required entities (business objects) for which you want to receive change event notifications.
  4. Click Save.
  5. Assign permissions to these objects to enable any change data capture events See Assign Permissions.

Assign Permissions

You must assign appropriate permissions to users to enable seamless interaction with Salesforce. You can navigate to each user's profile page and define access levels such as for read, write, delete, view all, and modify all for both standard and custom data objects.

Also, ensure that users have permissions to publish or subscribe to platform events. To configure permissions for objects involved in Change Data Capture events, you must first select entities for Change Data Capture Events and then define the required access levels for relevant standard and custom data objects.

  1. Navigate to Setup: 
  2. In the Quick Find field, search for Profiles.
  3. Select the profile of the user you want to modify.
  4. Click Edit.
    You can now edit/assign the permissions to standard and custom objects for basic access and data administration operations.
    • Basic Access (Read, Create, Edit, and Delete)
    • Data Administration (View all Records, modify all Records, and View all Fields)
  5. Enable Basic Access permissions for Platform Events.
    • Read (Allows user to subscribe to the event)
    • Create (Allows user to publish the event)
  6. Save the changes.