How to configure the Salesforce Connected Application for Work-Relay deployment

From Release 8.2:

New in Release 8.0, Work-Relay deployment uses the Salesforce Connected App authentication mechanism, rather than direct username and password+token authorization. Connected App authentication is a secure connection and authentication mechanism between Salesforce orgs, as it doesn’t require storing target Salesforce org credentials in a Salesforce Source Org.

Note: The following actions should be performed in the Target Organization.

The following information is required in order to configure deployment settings:

  • Organization Name - A user-defined name that identifies the Target Organization.  (1)
  • Domain URL - The URL of the Target Organization. This value can be quickly located by clicking the Profile icon and copying the value beneath your name (2). Remember to add "https://" at the beginning.
  • Client Key (3) and Client Secret (4) - These values should be obtained once from Target Organization via the Work-Relay Connect application, as described below.

To create the Key and Secret, the following actions must be performed by the Target Organization admin:

  • Add and configure the Salesforce Connected Application
  • Set Up the Client Credentials Flow

Configure Connected App

In the Target Organization (to which Work-Relay components will be deployed), perform the following actions:

  1. Navigate to Setup and open App Manager
  2. Click the New Connected App button (5)
  3. Set the following properties:
    • Connected App Name = Work-Relay Connect
    • API Name = Work_Relay_Connect
    • Contact Email = (email address of responsible person)
    • Enable OAuth Settings = true
    • Callback URL (choose the appropriate value, depending upon org type):
    • Selected OAuth Scopes = Full access (full)
    • Require Secret for Web Server Flow = true
    • Require Secret for Refresh Token Flow = true
    • Enable Client Credentials Flow = true
  4. Leave other properties set to their defaults and save the Connected App

Set Up the Client Credentials Flow

  1. In App Manager, locate the newly created Connected App named "Work-Relay Connect" and click "Manage" in the row actions menu (6).
  2. Click the Edit Policies button (7) on the Application Management page.
  3. In the Client Credentials Flow section, select an appropriate User in the Run As field (8). This is the User that will be used to perform deployments.
  4. Click Save button.

Retrieve the Client Key and Client Secret

  1. In App Manager, locate the newly-created Connected App named "Work-Relay Connect" and click "View" in the row actions menu.
  2. Click the Manage Consumer Details button (9).
  3. Provide the verification code (11), which will be delivered to your user's email address, to grant access to the Connected App (10).
  4. Click the Verify button (12).
  5. The Consumer Details page of Connected App will display the Consumer Key (13) and Secret (14), which are automatically generated.

This Consumer Key and Consumer Secret must then be entered in the Target Organization Configuration., in order to be used for future Work-Relay Deployments.

0 Comments

Add your comment

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.