Riva Insight On-Premises Prerequisites - Salesforce External Client App (ECA)

Curtis Massie
Curtis Massie
  • Updated

 

Start a new External Client App

  1. Go to Setup (gear icon at the top-right)
  2. On the left in the "Quick Find" box, search for 'External'
  3. Under 'Apps" > 'External Client Apps', select 'External Client App Manager'
  4. Select 'New External Client App'

 

Basic Information

  1. Fill out the Information for the new External Client App so that it is clear that the ECA is for use with Riva Insight
  2. For the logo, if the Riva logo is preferred, you may use 
    https://www-us.rivainsight.com/live/Content/Images/insight128.png  
    for the Logo Image URL and Icon URL

 

OAuth Settings

  1. Expand 'API (Enable OAuth Settings)
  2. Select 'Enable OAuth'

 

App Settings

  1. Add the callback URL in format https://{dnsname}:{port}/{basepath}/salesforce-oauth
    For example: https://riva.myorg.local:5001/insight/salesforce-oauth 

Note:

  • The callback URLs must be all in lowercase
  • Multiple callback urls can be added (use a new line for each callback url)
  • dnsname is fully qualified domain name (fqdn)
  • port default is 5001 is (can be changed during the Insight setup)
  • basepath default is insight  (can be changed during the Insight setup)
  • exclude the port if using 443 as the Insight port

If behind a load balancer:

  • Ensure the front-end Insight url is added (exclude the port if using 443)
  • Add both the local server urls and load balancer urls to aid with validation/troubleshooting to aid with validation/troubleshooting
  1. For OAuth Scopes, select the following scopes:
    • Access the identity URL service (id, profile, email)
    • Manage user data via APIs (api)
    • Perform requests at any time (refresh_token, offline_access)

 

Flow Enablement

  1. Select 'Enable Authorization Code and Credentials Flow'

Security

  1. Keep the default security settings, which would have the following enabled:
    • Require Proof Key for Code Exchange (PKCE) extension for Supported Authorization Flows
    • Enable Refresh Token Rotation
    • Limit Idle Refresh Token Time-to-Live (TTL) to 30 Days

Create the App

  1. The remaining sections can remain as is
  2. When ready, click on the "Create" button at the very bottom of the page

 

Access Consumer Key and Consumer Secret

  1. Go back to External Client App Manager
  2. Find the Insight External Client App that was just created and click on it
  1. Click on the Settings tab
  2. Click on the "Edit" button
  1. Scroll down to and expand "OAuth Settings"
  2. Click on "Consumer Key and Secret"
  1. The Consumer Details will open with the Consumer Key and Secret
  2. Make note of the values as they will be used later in the Riva Insight configuration