How to Deploy Veeam Backup for Salesforce External Client App
Purpose
This article documents how to create an External Client App (ECA) in Salesforce to integrate with Veeam Backup for Salesforce via Salesforce API. An ECA with proper permissions is required for Veeam Backup for Salesforce to integrate with Salesforce API using the OAuth 2.0 protocol.
Solution
Important Notes
- A separate ECA must be created and configured for every Salesforce organization that Veeam Backup for Salesforce connects to.
- If a Salesforce sandbox is refreshed, the associated ECA must be recreated.
Create New External Client App
- Click Setup in the top-right corner.
- Under Apps, expand Apps, and select External Client Apps.
- In the External Client App Manager, click New External Client App.
Shown is a shortcut of searching from the first few characters of the page's name, External Client App Manager.
- In the New External Client App form that appears, fill in the following:
- Basic Information Section
- External Client App Name
- API Name
- Contact Email
- Distribution state = Local
- API (Enable OAuth Settings) Section
- Toggle Enable OAuth Checkbox On
- App Settings Section
- Enter Callback URL
The Callback URL must match the FQDN and/or IP address of the machine where Veeam Backup for Salesforce is installed. Review the Veeam Backup for Salesforce user guide Create External Client App page for more details on identifying what information should be entered into the Callback URL field.
Note: A trailing forward slash must not be included. - Add the required OAuth Scopes:
- Full access (full)
- Access unique user identifiers (openid)
This scope is only needed if you use Salesforce as an identity provider. - Perform requests at any time (refresh_token, offline_access)
- Enter Callback URL
- Basic Information Section
- Click Create.
Add Callback URL to IP Restriction List
If access to an Organization is controlled using IP restrictions, be sure to add the Callback URL to the list of allowed IP addresses for the users used to connect to Salesforce and execute backup and restore.
- Note that enabling those settings for Salesforce might take some time.
- While waiting for the settings to become active, review the Salesforce security settings to ensure that the following option is disabled (unchecked):
Security > Session Settings > Lock sessions to the IP address from which they originated
Copy Token Key and Secret
- In the Settings > OAuth Settings, click Consumer Key and Secret.
- You'll be prompted to Verify Your Identity.
- On the page that loads, copy and save the Consumer Key and Consumer Secret to use later within Veeam Backup for Salesforce.
Note: Connection tokens will not work before the process is complete.
If this KB article did not resolve your issue or you need further assistance with Veeam software, please create a Veeam Support Case.
To submit feedback regarding this article, please click this link: Send Article Feedback
To report a typo on this page, highlight the typo with your mouse and press CTRL + Enter.
Spelling error in text
Thank you!
Your feedback has been received and will be reviewed.
KB Feedback/Suggestion
This form is only for KB Feedback/Suggestions, if you need help with the software open a support case
Thank you!
Your feedback has been received and will be reviewed.
Oops! Something went wrong.
Please, try again later.