From 82e31310563f3f53edc35d3436260b641a6ba525 Mon Sep 17 00:00:00 2001 From: parth-elastic <124889037+parth-elastic@users.noreply.github.com> Date: Mon, 11 Dec 2023 11:04:22 +0530 Subject: [PATCH] [GitHub] DLS documentation (#1956) Co-authored-by: Tim Grein Co-authored-by: Praveen Kukreja <90465691+praveen-elastic@users.noreply.github.com> --- docs/document-level-security/GITHUB.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/document-level-security/GITHUB.md diff --git a/docs/document-level-security/GITHUB.md b/docs/document-level-security/GITHUB.md new file mode 100644 index 000000000..4df12919f --- /dev/null +++ b/docs/document-level-security/GITHUB.md @@ -0,0 +1,19 @@ +### Setting up the GitHub connector + +See the [Developer guide](../../docs/DEVELOPING.md) for setting up connectors. + +## Document level security + +Document level security (DLS) enables you to restrict access to documents based on user permissions. This feature is only available, if the `Repository Type` is set to `Organization` in the GitHub connector. + +Refer to [document level security](https://www.elastic.co/guide/en/enterprise-search/master/dls.html) for more information. + +**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 from GitHub with DLS enabled, when building a search application. + +#### Additional Configuration + +##### `Enable document level security` + +Toggle to enable [document level security (DLS)](https://www.elastic.co/guide/en/enterprise-search/master/dls.html). When enabled: +- Full syncs will fetch access control lists for each document and store them in the `_allow_access_control` field. +- Access control syncs will fetch users' access control lists and store them in a separate index.