Skip to content

Commit d6e0cd4

Browse files
Documentation for Salesforce DLS (#2056)
Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
1 parent 038e472 commit d6e0cd4

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed
+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
### Setting up the Salesforce connector
2+
3+
See the [Developer guide](../../docs/DEVELOPING.md) for setting up connectors.
4+
5+
## Document level security
6+
7+
Document level security (DLS) enables you to restrict access to documents based on a user'­s permissions. This feature is available by default for the Salesforce connector.
8+
Salesforce connector DLS supports for both standard & custom objects.
9+
10+
Refer to [document level security](https://www.elastic.co/guide/en/enterprise-search/master/dls.html) for more information.
11+
12+
Salesforce allows users to set permissions in different ways i.e. via Profiles, Permission sets and Permission set Groups.
13+
14+
For guidance, refer to these [video tutorials](https://howtovideos.hubs.vidyard.com/watch/B1bQnMFg2VyZq7V6zXQjPg#:~:text=This%20is%20a%20must%20watch,records%20in%20your%20Salesforce%20organization) about setting Salesforce permissions.
15+
16+
To ingest any standard or custom objects, users must ensure that at least `Read` permission is granted to that object. This can be granted using any of the following methods for setting permissions.
17+
18+
### Set Permissions using Profiles
19+
20+
Refer to the [official documentation](https://help.salesforce.com/s/articleView?id=sf.admin_userprofiles.htm&type=5) for setting permissions via Profiles.
21+
22+
### Set Permissions using Permissions Set
23+
24+
Refer to the [official documentation](https://help.salesforce.com/s/articleView?id=sf.perm_sets_overview.htm&language=en_US&type=5) for setting permissions via Permissions Sets.
25+
26+
### Set Permissions using Permissions Set group
27+
28+
Refer to the [official documentation](https://help.salesforce.com/s/articleView?id=sf.perm_set_groups.htm&type=5) for setting permissions via Permissions Set Groups.
29+
30+
### Set Profiles, Permission Set and Permission Set Groups to the User
31+
32+
1. Go to `Administration` under the `Users` section.
33+
2. Select `Users` and choose the user to set the permissions to.
34+
3. Set the `Profile`, `Permission Set`or `Permission Set Groups` created in the earlier steps.
35+
36+
**Note:** Refer to [DLS in Search Applications](https://www.elastic.co/guide/en/enterprise-search/master/dls-e2e-guide.html) to learn how to ingest data with DLS enabled, when building a search application.
37+
38+
#### Additional Configuration
39+
40+
##### `Enable document level security`
41+
42+
Toggle to enable [document level security (DLS)](https://www.elastic.co/guide/en/enterprise-search/master/dls.html). When enabled:
43+
- Full syncs will fetch access control lists for each document and store them in the `_allow_access_control` field.
44+
- Access control syncs will fetch users' access control lists and store them in a separate index.

0 commit comments

Comments
 (0)