Skip to content

Commit ea328f6

Browse files
authored
Update salesforce doc. (#517)
1 parent 2ddb10c commit ea328f6

8 files changed

Lines changed: 36 additions & 37 deletions
4.36 KB
Loading
69.4 KB
Loading
Binary file not shown.
387 KB
Loading
176 KB
Loading
Binary file not shown.
Binary file not shown.

docs/knowledge-base/oauth_app/salesforce.mdx

Lines changed: 36 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -17,65 +17,64 @@ description: "Complete guide to creating and configuring a Salesforce OAuth appl
1717
<img src="/images/knowledge-base/salesforce_oauth_app/salesforce_step1_login.png" alt="Salesforce Developer Login" />
1818

1919

20-
## Step 2: Create a New App
20+
## Step 2: Enable Connected Apps
2121

2222
1. Once logged in, go to **"Setup Menu"** (Gear Icon) and click **"Setup"**
23-
2. Search **"App Manager"** in the **"Quick Find"** search box
24-
3. In **"App Manager"**, choose **"New External Client App"**
23+
2. Search **"External Client Apps"** in the **"Quick Find"** search box
24+
3. In **"External Client App Settings"**, enable **"Allow creation of connected apps"**
25+
4. Click **"New Connected App"**
2526

2627
<img src="/images/knowledge-base/salesforce_oauth_app/salesforce_step2_create_app.png" alt="Salesforce App Creation" />
2728

2829
## Step 3: Fill Basic App Information
2930

3031
1. Fill the necessary app details:
31-
- **App name**: Your application name (e.g., your brand name)
32-
- **API Name**: Your API Name (e.g similar to app name)
33-
- **Distribution State**: Local/Packaged (recommended to set as **Local**)
34-
- **Other Information**: **Contact Mail**, **Contact Phone**, **Description**, **Info Url**, **Logo Image Url**, and **Icon Url**
32+
- **Connected App Name**: Your application name (e.g., your brand name)
33+
- **API Name**: Auto-generated from app name (only letters, numbers, and underscores allowed)
34+
- **Contact Email**: Your contact email for Salesforce support
35+
- **Contact Phone**: Your contact phone for Salesforce support
36+
- **Logo Image URL**: (Optional) HTTPS URL for your app logo (max 100 KB, preferably under 20 KB)
37+
- **Info URL**: (Optional) Web page with more information about your app
38+
- **Description**: (Optional) Up to 256 characters describing your app
3539

3640
<img src="/images/knowledge-base/salesforce_oauth_app/salesforce_step3_basic_info.png" alt="Basic App Information" />
3741

38-
## Step 4: Configure OAuth Settings
39-
4042
<Note>
4143
Klavis Salesforce MCP Server uses the following OAuth scopes: `api,refresh_token,offline_access`
4244
</Note>
4345

44-
1. **Redirect URIs**: Add your callback URL:
45-
- `https://api.klavis.ai/oauth/salesforce/callback`
46+
1. In the **API (Enable OAuth Settings)** section:
47+
- Select **"Enable OAuth Settings"**
48+
- **Callback URL**: Enter `https://api.klavis.ai/oauth/salesforce/callback`
49+
50+
2. **Select OAuth Scopes**: Move required scopes from **"Available OAuth Scopes"** to **"Selected OAuth Scopes"**:
51+
- `Manage User Data via APIs (api)` - required to manage user data via APIs
52+
- `Perform requests on your behalf at any time (refresh_token, offline_access)` - required to perform requests at any time
4653

47-
2. **Scopes**: Move required scopes from **"Available"** to **"Selected"** Oauth scope menu:
48-
- `api` (required to manage user data via APIs)
49-
- `refresh_token,offline_access` (required to perform requests at any time)
50-
3. Click on **"Create"** app
54+
3. **Additional Settings**:
55+
- Enable **"Require Secret for Web Server Flow"** if your app can keep the client secret confidential
56+
- Enable **"Require Secret for Refresh Token Flow"**
57+
- Enable **"Enable Authorization Code and Credentials Flow"**
5158

52-
<img src="/images/knowledge-base/salesforce_oauth_app/salesforce_step4_callback_and_scopes.png" alt="OAuth Settings and Connection Configuration" />
59+
4. Click **"Save"** to create the app
5360

54-
## Step 5: Get Consumer Key and Secret
61+
## Step 4: Get Consumer Key and Secret
5562

5663
After creating the app, follow these steps to get the credentials.
5764

5865
1. From dashboard, go to **"Setup Menu"** (Gear Icon) and click **"Setup"**
59-
2. Search **"External Client App Manager"** in the **"Quick Find"** search box
60-
3. Click on App that you created. Navigate to Setting -> OAuth Settings
61-
4. Under **"App Settings"**, click on **"Consumer Key and Secret"**
62-
5. To access credentials, verify your identity using **verification code** sent to your connected mail.
63-
6. Copy **Consumer Key** and **Consumer Secret** from consumer details menu (keep it secure!)
64-
65-
<img src="/images/knowledge-base/salesforce_oauth_app/salesforce_step5_get_consumer_key_and_secret.png" alt="Get Consumer Key and Secret" />
66-
67-
## Step 6: Get Remaining credentials (Security Token, Username, Password, Instance Id)
68-
69-
1. In user settings, **"My Personal Information"** -> **"Advanced User Details"**
70-
- Get **Username** from User Details section
71-
- Use **Password** that you set while creating the account.
72-
- Copy **Instance ID** from address bar or Login History -> Login Url tab
73-
2. Go to user setting, **"My Personal Information"** -> **"Reset My Security Token"**
74-
- Click **Reset Security Token**
75-
- Security Token is sent to you via mail (keep it secure!)
76-
<img src="/images/knowledge-base/salesforce_oauth_app/salesforce_step6_security_token.png" alt="Get Security Token" />
77-
78-
## (Optional) Step 7: White Labeling
66+
2. Search **"App Manager"** in the **"Quick Find"** search box
67+
3. Find your connected app in the list and click the dropdown arrow, then select **"View"**
68+
69+
<img src="/images/knowledge-base/salesforce_oauth_app/salesforce_step4_view_connected_apps.png" alt="View Connected Apps" />
70+
71+
4. In the **API (Enable OAuth Settings)** section, click **"Manage Consumer Details"**
72+
5. Verify your identity using the **verification code** sent to your email
73+
6. Copy the **Consumer Key** and **Consumer Secret** (keep them secure!)
74+
75+
<img src="/images/knowledge-base/salesforce_oauth_app/salesforce_step4_view_consumer_key_and_secret.png" alt="Get Consumer Key and Secret" />
76+
77+
## (Optional) Step 5: White Labeling
7978

8079
<Note>
8180
White labeling allows you to customize the OAuth experience with your own branding instead of Klavis AI's.

0 commit comments

Comments
 (0)