Set Up the Salesforce Connected Application

The goal of these instructions is to enable amberSearch to access Salesforce environment. For that purpose the administrator of Salesforce should create a so-called connected app in their environment. The connected app serves as a client which grants particular API permissions that enable amberSearch to access and index the contents from Salesforce.

Step 1: Create the connected app

  • Navigate to Setup

  • Search for app manager in the Quick Find search box and navigate to the App Manager

  • Press New Connected App and input the following basic data

    • Connected App Name: amberSearch Connected App

    • Contact Email: it@amber.de

      • Or use your own Email. Sometimes you receive verification codes

  • Check Enable OAuth Settings

    • Set Callback URL: https://login.salesforce.com/services/oauth2/success

    • Select Manage user data via APIs (API) from Selected Oauth Scopes

    • Furthermore, set the following checks:

      • Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows

      • Require Secret for Web Server Flow

      • Require Secret for Refresh Token Flow

      • Enable Client Credentials Flow

  • Save

Step 2: Create a new user

Depending on the modules and contents that should be integrated in amberSearch, the new user, that should be created, has to have access to these contents. For instance, if Service Cloud is the relevant module from Salesforce, then the user should have access to the Cases.

  • Navigate to Setup

  • Search for users in the Quick Find search box and navigate to Users

  • Press New User

  • Make sure to assign the necessary license/profile to the user

Step 3: Further configuration of the connected app

  • Navigate to Setup, search for connected apps in the Quick Find search box and navigate to Manage Connected Apps

  • Press Edit for the connected application from Step 1

  • OAuth Policies -> Permitted Users -> Select All users may self-authorize

  • Client Credentials Flow -> Run as -> Set the user from Step 2

Step 4: Retrieve the consumer details

In this step we retrieve the consumer details (client id and secret) which in Salesforce terminology are called consumer key and consumer secret.

  • Navigate to Setup, search for app manager in the Quick Find search box and navigate to App Manager

  • View the connected app from Step 1

  • Press Manage consumer Details (within the API (Enable OAuth Settings) section)

  • Provide the Consumer Key and Consumer Secret to amberSearch Team