Connectors
SharePoint Online
Index SharePoint Online sites, libraries, pages, and list items, with document-level permissions.
The SharePoint Online connector indexes sites, document libraries, pages, lists, list items, and attachments. It syncs item permissions for document-level security.
Prerequisites
- A Microsoft Entra ID (Azure AD) tenant with admin consent rights.
- An app registration EigenSearch authenticates as (details below).
1. Register an Entra ID app
In Entra ID → App registrations → New registration, collect:
- Tenant ID and tenant name
- Client ID (Application ID)
Add certificate credentials. Microsoft is retiring client secrets.
2. Grant Graph API permissions
Add these application permissions and grant admin consent:
| Permission | Why |
|---|---|
Sites.Read.All | Read site content. |
Files.Read.All | Read documents and attachments. |
Groups.Read.All | Resolve group-based permissions. |
User.Read.All | Resolve user-based permissions. |
To limit access to specific sites, use Sites.Selected and grant access per site collection.
3. Configure the connector
| Field | Description |
|---|---|
tenant_id / tenant_name | From the app registration. |
client_id | Application ID. |
certificate / private_key | Certificate credentials. |
site_collections | Sites to index; * for all. |
fetch_subsites | Include child sites. |
use_document_level_security | Sync ACLs and enforce them at query time. |
Sync behaviour
- Full sync re-indexes selected sites. Run after site or permission rule changes.
- Incremental sync indexes scheduled changes.
- With document-level security enabled, each item is indexed with its ACL. Results respect the calling user's SharePoint permissions.
Notes
- Large binaries are extracted up to a configurable size limit.
- Folders with unique (non-inherited) permissions are resolved explicitly during sync.