Salesforce
Salesforce is a cloud-based customer relationship management (CRM) platform for managing support, sales, and marketing. You can connect your Salesforce org as a data source for your managed knowledge base to crawl Salesforce Knowledge articles, including their attachments, and documents.
Important
Salesforce data sources don't support document-level access control lists (ACLs). All authenticated users who can query the knowledge base can see all crawled content.
Supported features
With a Salesforce data source, you can use the following features:
-
Salesforce Knowledge article crawling, including article attachments, and document crawling
-
Archived Knowledge article crawling
-
OAuth 2.0 Client Credentials (2LO) authentication
-
Scoping the crawl with a data category filter for Knowledge articles and a folder filter for documents
-
Maximum file size filtering
Authentication method
To connect a Salesforce data source, use OAuth 2.0 Client Credentials (2LO) authentication, which Salesforce calls the Client Credentials Flow. You register an External Client App in Salesforce and assign a dedicated Run-As integration user. The connector authenticates as the app and acts as that user, with no interactive sign-in. The Run-As user's permissions govern what the connector can crawl. For setup steps, see Set up OAuth 2.0 Client Credentials authentication for Salesforce.
Prerequisites
In Salesforce, make sure that you complete the following prerequisites:
-
Have administrator access to the Salesforce org, with permission to create and manage External Client Apps.
-
Enable My Domain, which is required for the Client Credentials Flow. Your instance URL looks like
https://.your-domain.my.salesforce.com -
Have a dedicated integration user to assign as the Run-As user.
-
Have an External Client App created and configured for the connector to authenticate with. See Set up OAuth 2.0 Client Credentials authentication for Salesforce.
In your AWS account, make sure that you complete the following prerequisites:
-
Store your authentication credentials in an AWS Secrets Manager secret and note the Amazon Resource Name (ARN) of the secret.
-
Include the necessary permissions to connect to your data source in your AWS Identity and Access Management (IAM) role/permissions policy for your knowledge base. For information on the required permissions, see Permissions to access your data sources.
How to set up a Salesforce data source
Setting up a Salesforce data source involves the following steps:
-
Set up authentication. Register and configure the External Client App in Salesforce, and store the credentials in AWS. See Set up OAuth 2.0 Client Credentials authentication for Salesforce.
-
Connect the data source. Create the Salesforce data source in the knowledge base using the AWS Management Console or the API. See Connect a Salesforce data source.