docs: document includeSubGroups config option

Signed-off-by: Florian Störkle <florian@stoerkle.net>
2024-02-19 08:35:18 +01:00
parent da7651605a
commit 24b3a3141b
1 changed files with 11 additions and 0 deletions
@@ -112,6 +112,17 @@ microsoftGraphOrg:
      search: '"description:One" AND ("displayName:Video" OR "displayName:Drive")'
 ```

+If you don't want to only ingest groups matching the `search` and/or `filter` query, but also the groups which are members of the matched groups, you can use the `includeSubGroups` configuration:
+
+```yaml
+microsoftGraphOrg:
+  providerId:
+    group:
+      filter: securityEnabled eq false and mailEnabled eq true and groupTypes/any(c:c+eq+'Unified')
+      search: '"description:One" AND ("displayName:Video" OR "displayName:Drive")'
+      includeSubGroups: true
+```
+
 In addition to these groups, one additional group will be created for your organization.
 All imported groups will be a child of this group.