You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit d6be8cb
Browse filesBrowse the repository at this point in the historyBrowse files
DOC-2415: update Salesforce connected app doc for External Client Apps
Salesforce has replaced connected app creation with External Client Apps
in newer organizations, so restructure the page around that flow and keep
the connected app steps as a clearly marked legacy path.
- Retitle the page to "Creating an External Client App" and refresh the
page title, meta description, and contextual links
- Add "Steps to Create an External Client App" with the App Manager flow,
distribution state, OAuth settings, callback URL, scopes, and the web
server / refresh token secret requirements
- Add "Fetch Consumer Details for an External Client App"
- Move the connected app steps under "Steps to Create a Connected App
(Legacy)", fold in the enable-connected-apps steps, and note that the
enable dialog only appears the first time
- Split the security token steps into their own "Reset the Security Token"
section and point to the metadata and user connection docs
- Expand the prerequisites to cover admin email access
- Fix the broken step numbering in the connected app steps
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WiPdCiPj7K1Y6Lna1ZGcri
metadesc: "A connected app is important to link external applications & the Salesforce ecosystem. This article discusses how to create a connected app in Salesforce."
2
+
title: "Creating an External Client App"
3
+
page_title: "Create an External Client App"
4
+
metadesc: "Create an External Client App in Salesforce to link your Salesforce organization to Testsigma and download metadata. Includes the legacy connected app steps."
5
5
noindex: false
6
6
order: 29.2
7
7
page_id: "Create Connected Application"
@@ -13,90 +13,157 @@ contextual_links:
13
13
name: "Prerequisites"
14
14
url: "#prerequisites"
15
15
- type: link
16
-
name: "Steps to Enable Connected Apps"
17
-
url: "#steps-to-enable-connected-apps"
16
+
name: "Steps to Create an External Client App"
17
+
url: "#steps-to-create-an-external-client-app"
18
18
- type: link
19
-
name: "Steps to Create a Connected App"
20
-
url: "#steps-to-create-a-connected-app"
19
+
name: "Fetch Consumer Details for an External Client App"
Creating a connected app is important to link external applications and the Salesforce ecosystem. With a connected app, you can integrate APIs, enable single sign-on (SSO), and build applications. This article discusses how to create a connected app in Salesforce.
34
+
Create an External Client App in Salesforce to link your Salesforce organization to Testsigma and download metadata. Salesforce has replaced connected app creation with External Client Apps in newer organizations. This article discusses how to create an External Client App in Salesforce and fetch the consumer details that Testsigma needs.
35
+
36
+
[[info | **NOTE**:]]
37
+
| If your Salesforce organization still offers a **New Connected App** option, follow [Steps to Create a Connected App (Legacy)](#steps-to-create-a-connected-app-legacy) instead.
29
38
30
39
---
31
40
32
41
> <pid="prerequisites">Prerequisites</p>
33
42
>
34
-
> Before you begin, ensure you have a Salesforce organization setup.
43
+
> Before you begin, ensure that:
44
+
> 1. A Salesforce organization exists.
45
+
> 2. The admin email for the organization is accessible, since the identity verification code and the security token are sent there.
35
46
36
47
---
37
48
38
-
## **Steps to Enable Connected Apps**
49
+
## **Steps to Create an External Client App**
50
+
51
+
1. Log into your Salesforce instance.
52
+
53
+
2. On the **Setup** page, enter **App Manager** in the quick finder, and click **App Manager**.
54
+
55
+
3. Click **New External Client App** at the top right of the **App Manager** list view.
56
+
57
+
4. In the **Basic Information** section, enter the **External Client App Name**, **API Name**, and **Contact Email**.
58
+
59
+
[[info | **NOTE**:]]
60
+
| Salesforce automatically fills in the **API Name** field.
61
+
62
+
5. Set **Distribution State** to **Local**.
63
+
64
+
6. Expand the **API (Enable OAuth Settings)** section and select the **Enable OAuth** checkbox.
65
+
66
+
7. In the **Callback URL** field, enter the Testsigma callback URL.
67
+
68
+
[[info | **NOTE**:]]
69
+
| Use this Callback URL: <ahref="https://salesforce-callback.testsigma.com/authorize/"rel="nofollow">https://salesforce-callback.testsigma.com/authorize/</a>
70
+
71
+
8. Select the required OAuth scopes and move them to the **Selected OAuth Scopes** list using the arrow control.
72
+
73
+
[[info | **NOTE**:]]
74
+
| The selected scopes are mandatory to connect to your Salesforce organization and download the metadata.
75
+
76
+
9. Under **Security**, select **Require Secret for Web Server Flow** and **Require Secret for Refresh Token Flow**.
77
+
78
+
[[info | **NOTE**:]]
79
+
| Testsigma connects through the standard OAuth web server (authorization code) flow, so you can leave the **Flow Enablement**, **Canvas**, **Mobile App Configuration**, and **Custom Attributes** sections unchanged.
80
+
81
+
10. Click **Create**.
82
+
83
+
[[info | **NOTE**:]]
84
+
| - Wait 10–15 minutes after creating the app before you establish a connection from Testsigma.
85
+
| - Some Salesforce editions do not include API access, and connections cannot be created in them. For more information, refer to <ahref="https://help.salesforce.com/s/articleView?id=000385436&type=1"rel="nofollow">Salesforce editions with API access</a>.
86
+
87
+
### **Fetch Consumer Details for an External Client App**
88
+
89
+
1. Open the External Client App you created and go to the **Settings** tab.
90
+
91
+
2. Expand the **OAuth Settings** section.
92
+
93
+
3. Click **Consumer Key and Secret**. The **Verify Your Identity** window opens in a new tab.
94
+
95
+
4. On the **Verify Your Identity** window, enter the OTP sent to the admin email. Upon verification, Salesforce displays the **Consumer Key** and **Consumer Secret**.
96
+
97
+
---
98
+
99
+
## **Steps to Create a Connected App (Legacy)**
100
+
101
+
[[info | **NOTE**:]]
102
+
| Salesforce has deprecated connected app creation. Follow these steps only if your organization still offers a **New Connected App** option. Otherwise, follow [Steps to Create an External Client App](#steps-to-create-an-external-client-app).
39
103
40
104
1. Log into your Salesforce instance.
41
105
42
106
2. On the **Setup** page, enter **Apps** in the quick finder, and click **Settings** under **External Client Apps**.
3. On the **External Client App Settings** page, under the **Connected Apps** section, enable the **Allow creation of connected apps** toggle.
109
+
3. On the **External Client App Settings** page, under the **Connected Apps** section, ensure the **Allow creation of connected apps** toggle is enabled.
| The dialog appears only the first time the toggle is enabled. If connected apps are already enabled in your organization, continue from the next step.
54
117
55
-
1. On the **External Client App Settings** page, click **New Connected App**.
| - Salesforce automatically fills in the **API Name** input field.
63
-
| - Other input fields are optional.
64
-
65
-
3. In the **API** section, select the **Enable OAuth Settings** checkbox to set **Callback URL** and **Selected OAuth Scopes**. The **Selected OAuth Scopes** are mandatory in the **Connected App** to connect & download the metadata.
66
-
67
-
- Use this Callback URL: <ahref="https://salesforce-callback.testsigma.com/authorize/"rel="nofollow">https://salesforce-callback.testsigma.com/authorize/</a>
125
+
| - Salesforce automatically fills in the **API Name** field.
126
+
| - The other fields are optional.
68
127
128
+
7. In the **API** section, select the **Enable OAuth Settings** checkbox to set the **Callback URL** and **Selected OAuth Scopes**.
| The selected scopes are mandatory to connect to your Salesforce organization and download the metadata. Use this Callback URL: <ahref="https://salesforce-callback.testsigma.com/authorize/"rel="nofollow">https://salesforce-callback.testsigma.com/authorize/</a>
| - Please wait for 10 - 15 minutes after creating the app, before trying to establish a connection.
76
-
| - A connected app is limited to only a few approvals. The system can revoke the oldest approval when the limit exceeds automatically. As a best practice, you can create a different connected app for each new application connection/connection.
77
-
| - Some Salesforce editions do not have API access. Generally, these editions are not used in development or production environments, and it is not possible to create connections within them. <br> <br>
78
-
| For more information on these editions, refer to the <ahref="https://help.salesforce.com/s/articleView?id=000385436&type=1"rel="nofollow">Salesforce editions with API access</a>.
79
-
80
-
---
138
+
| - Wait 10–15 minutes after creating the app before you establish a connection from Testsigma.
139
+
| - A connected app is limited to a few approvals. When the limit is exceeded, the system can automatically revoke the oldest approval. As a best practice, create a separate connected app for each application connection.
140
+
| - Some Salesforce editions do not include API access, and connections cannot be created in them. For more information, refer to <ahref="https://help.salesforce.com/s/articleView?id=000385436&type=1"rel="nofollow">Salesforce editions with API access</a>.
81
141
82
-
## **Fetch Consumer Details**
142
+
###**Fetch Consumer Details for a Connected App (Legacy)**
83
143
84
-
1. Edit the connected app and click on **Manage Consumer Details**. This will open a new window.
144
+
1. Edit the connected app and click **Manage Consumer Details**. The **Verify Your Identity** window opens in a new tab.
4. For Security Token, go to **My Personal Information > Reset My Security Token** and click on **Reset Security Token**. A new token will be sent to admin mail. Please refer to <ahref="https://help.salesforce.com/s/articleView?id=xcloud.user_security_token.htm&type=5"rel="nofollow">Salesforce</a> for more information.
156
+
---
157
+
158
+
## **Reset the Security Token**
159
+
160
+
To get the security token, go to **My Personal Information > Reset My Security Token** and click **Reset Security Token**. Salesforce sends a new token to the admin email. For more information, refer to <ahref="https://help.salesforce.com/s/articleView?id=xcloud.user_security_token.htm&type=5"rel="nofollow">Salesforce</a>.
161
+
162
+
[[info | **NOTE**:]]
163
+
| Use the **Consumer Key**, **Consumer Secret**, and the security token when you create a [metadata connection](https://testsigma.com/docs/salesforce-testing/metadata-connections/) or a [user connection](https://testsigma.com/docs/salesforce-testing/user-connections/) in Testsigma.
97
164
98
165
<br>
99
166
100
-
> Refer to the [documentation on Salesforce troubleshooting](https://testsigma.com/docs/troubleshooting/salesforce-testing/most-common-issues/) guide for the most common issues while creating a connected app.
167
+
> Refer to the [documentation on Salesforce troubleshooting](https://testsigma.com/docs/troubleshooting/salesforce-testing/most-common-issues/) guide for the most common issues while setting up an app for the connection.
0 commit comments