SharePoint Connector
Connect to Microsoft SharePoint Online to index documents, sites, and libraries.
Overview
The SharePoint connector allows you to:
- Index SharePoint Online sites
- Access document libraries
- Sync permissions from Microsoft 365
- Support multiple site collections
Prerequisites
- Microsoft 365 account
- SharePoint Online access
- Azure AD app registration (admin setup)
Authentication
OAuth 2.0
- Click Connect with Microsoft
- Sign in to Microsoft 365
- Consent to requested permissions
- Return to ZenSearch
Required Permissions
| Permission | Purpose |
|---|---|
Sites.Read.All | Read site content |
Files.Read.All | Access documents |
Configuration
| Setting | Description |
|---|---|
| Site URLs | SharePoint sites to index |
| Document Libraries | Specific libraries or all |
| Include Subsites | Index subsites |
| site_ids | string[] — Multiple site IDs to sync |
| include_all_sites | boolean — Sync all accessible sites |
| include_subfolders | boolean — Recursive folder traversal |
| include_versions | boolean — Include file version history |
| include_permissions | boolean — Sync document permissions to ZenSearch |
| exclude_folders | string[] — Folder paths to exclude |
| exclude_patterns | string[] — File pattern exclusions |
| modified_after | string — Only sync files modified after this date (ISO 8601) |
| modified_before | string — Only sync files modified before this date (ISO 8601) |
Setup Steps
- Add Connector: Knowledge → Add Data Source → SharePoint
- Authorize: Connect with Microsoft OAuth
- Select Sites: Enter site URLs
- Configure Libraries: Choose document libraries
- Test & Create: Verify and save
Site Selection
Sites:
- https://company.sharepoint.com/sites/Engineering
- https://company.sharepoint.com/sites/Marketing
Content Indexed
| Content | Included |
|---|---|
| Documents | Yes |
| Lists | Optional |
| Pages | Yes |
| Attachments | Yes |
Permission Sync
SharePoint permissions are synced:
- Site permissions
- Library permissions
- Item-level permissions
Best Practices
- Start with key site collections
- Focus on document libraries
- Enable permission sync
- Exclude archive sites
Troubleshooting
Access denied: Verify Azure AD permissions are consented
Missing sites: Check site URL format and access rights