- Elasticsearch Guide: other versions:
- What’s new in 8.17
- Elasticsearch basics
- Quick starts
- Set up Elasticsearch
- Run Elasticsearch locally
- Installing Elasticsearch
- Configuring Elasticsearch
- Important Elasticsearch configuration
- Secure settings
- Auditing settings
- Circuit breaker settings
- Cluster-level shard allocation and routing settings
- Miscellaneous cluster settings
- Cross-cluster replication settings
- Discovery and cluster formation settings
- Data stream lifecycle settings
- Field data cache settings
- Local gateway settings
- Health Diagnostic settings
- Index lifecycle management settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- Inference settings
- License settings
- Machine learning settings
- Monitoring settings
- Node settings
- Networking
- Node query cache settings
- Path settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot and restore settings
- Transforms settings
- Thread pools
- Watcher settings
- Set JVM options
- Important system configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- All permission check
- Discovery configuration check
- Bootstrap Checks for X-Pack
- Starting Elasticsearch
- Stopping Elasticsearch
- Discovery and cluster formation
- Add and remove nodes in your cluster
- Full-cluster restart and rolling restart
- Remote clusters
- Plugins
- Upgrade Elasticsearch
- Index modules
- Mapping
- Dynamic mapping
- Explicit mapping
- Runtime fields
- Field data types
- Aggregate metric
- Alias
- Arrays
- Binary
- Boolean
- Completion
- Date
- Date nanoseconds
- Dense vector
- Flattened
- Geopoint
- Geoshape
- Histogram
- IP
- Join
- Keyword
- Nested
- Numeric
- Object
- Pass-through object
- Percolator
- Point
- Range
- Rank feature
- Rank features
- Search-as-you-type
- Semantic text
- Shape
- Sparse vector
- Text
- Token count
- Unsigned long
- Version
- Metadata fields
- Mapping parameters
analyzer
coerce
copy_to
doc_values
dynamic
eager_global_ordinals
enabled
format
ignore_above
index.mapping.ignore_above
ignore_malformed
index
index_options
index_phrases
index_prefixes
meta
fields
normalizer
norms
null_value
position_increment_gap
properties
search_analyzer
similarity
store
subobjects
term_vector
- Mapping limit settings
- Removal of mapping types
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Token filter reference
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten graph
- Hunspell
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword marker
- Keyword repeat
- KStem
- Length
- Limit token count
- Lowercase
- MinHash
- Multiplexer
- N-gram
- Normalization
- Pattern capture
- Pattern replace
- Phonetic
- Porter stem
- Predicate script
- Remove duplicates
- Reverse
- Shingle
- Snowball
- Stemmer
- Stemmer override
- Stop
- Synonym
- Synonym graph
- Trim
- Truncate
- Unique
- Uppercase
- Word delimiter
- Word delimiter graph
- Character filters reference
- Normalizers
- Index templates
- Data streams
- Ingest pipelines
- Example: Parse logs
- Enrich your data
- Processor reference
- Append
- Attachment
- Bytes
- Circle
- Community ID
- Convert
- CSV
- Date
- Date index name
- Dissect
- Dot expander
- Drop
- Enrich
- Fail
- Fingerprint
- Foreach
- Geo-grid
- GeoIP
- Grok
- Gsub
- HTML strip
- Inference
- IP Location
- Join
- JSON
- KV
- Lowercase
- Network direction
- Pipeline
- Redact
- Registered domain
- Remove
- Rename
- Reroute
- Script
- Set
- Set security user
- Sort
- Split
- Terminate
- Trim
- Uppercase
- URL decode
- URI parts
- User agent
- Ingest pipelines in Search
- Aliases
- Search your data
- Re-ranking
- Query DSL
- Aggregations
- Bucket aggregations
- Adjacency matrix
- Auto-interval date histogram
- Categorize text
- Children
- Composite
- Date histogram
- Date range
- Diversified sampler
- Filter
- Filters
- Frequent item sets
- Geo-distance
- Geohash grid
- Geohex grid
- Geotile grid
- Global
- Histogram
- IP prefix
- IP range
- Missing
- Multi Terms
- Nested
- Parent
- Random sampler
- Range
- Rare terms
- Reverse nested
- Sampler
- Significant terms
- Significant text
- Terms
- Time series
- Variable width histogram
- Subtleties of bucketing range fields
- Metrics aggregations
- Pipeline aggregations
- Average bucket
- Bucket script
- Bucket count K-S test
- Bucket correlation
- Bucket selector
- Bucket sort
- Change point
- Cumulative cardinality
- Cumulative sum
- Derivative
- Extended stats bucket
- Inference bucket
- Max bucket
- Min bucket
- Moving function
- Moving percentiles
- Normalize
- Percentiles bucket
- Serial differencing
- Stats bucket
- Sum bucket
- Bucket aggregations
- Geospatial analysis
- Connectors
- EQL
- ES|QL
- SQL
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Scripting
- Data management
- ILM: Manage the index lifecycle
- Tutorial: Customize built-in policies
- Tutorial: Automate rollover
- Index management in Kibana
- Overview
- Concepts
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Troubleshooting index lifecycle management errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- Data tiers
- Autoscaling
- Monitor a cluster
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure the Elastic Stack
- Elasticsearch security principles
- Start the Elastic Stack with security enabled automatically
- Manually configure security
- Updating node security certificates
- User authentication
- Built-in users
- Service accounts
- Internal users
- Token-based authentication services
- User profiles
- Realms
- Realm chains
- Security domains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- JWT authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Looking up users without authentication
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Built-in roles
- Defining roles
- Role restriction
- Security privileges
- Document level security
- Field level security
- Granting privileges for data streams and aliases
- Mapping users and groups to roles
- Setting up field and document level security
- Submitting requests on behalf of other users
- Configuring authorization delegation
- Customizing roles and authorization
- Enable audit logging
- Restricting connections with IP filtering
- Securing clients and integrations
- Operator privileges
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Watcher
- Cross-cluster replication
- Data store architecture
- REST APIs
- API conventions
- Common options
- REST API compatibility
- Autoscaling APIs
- Behavioral Analytics APIs
- Compact and aligned text (CAT) APIs
- cat aliases
- cat allocation
- cat anomaly detectors
- cat component templates
- cat count
- cat data frame analytics
- cat datafeeds
- cat fielddata
- cat health
- cat indices
- cat master
- cat nodeattrs
- cat nodes
- cat pending tasks
- cat plugins
- cat recovery
- cat repositories
- cat segments
- cat shards
- cat snapshots
- cat task management
- cat templates
- cat thread pool
- cat trained model
- cat transforms
- Cluster APIs
- Cluster allocation explain
- Cluster get settings
- Cluster health
- Health
- Cluster reroute
- Cluster state
- Cluster stats
- Cluster update settings
- Nodes feature usage
- Nodes hot threads
- Nodes info
- Prevalidate node removal
- Nodes reload secure settings
- Nodes stats
- Cluster Info
- Pending cluster tasks
- Remote cluster info
- Task management
- Voting configuration exclusions
- Create or update desired nodes
- Get desired nodes
- Delete desired nodes
- Get desired balance
- Reset desired balance
- Cross-cluster replication APIs
- Connector APIs
- Create connector
- Delete connector
- Get connector
- List connectors
- Update connector API key id
- Update connector configuration
- Update connector index name
- Update connector features
- Update connector filtering
- Update connector name and description
- Update connector pipeline
- Update connector scheduling
- Update connector service type
- Create connector sync job
- Cancel connector sync job
- Delete connector sync job
- Get connector sync job
- List connector sync jobs
- Check in a connector
- Update connector error
- Update connector last sync stats
- Update connector status
- Check in connector sync job
- Claim connector sync job
- Set connector sync job error
- Set connector sync job stats
- Data stream APIs
- Document APIs
- Enrich APIs
- EQL APIs
- ES|QL APIs
- Features APIs
- Fleet APIs
- Graph explore API
- Index APIs
- Alias exists
- Aliases
- Analyze
- Analyze index disk usage
- Clear cache
- Clone index
- Close index
- Create index
- Create or update alias
- Create or update component template
- Create or update index template
- Create or update index template (legacy)
- Delete component template
- Delete dangling index
- Delete alias
- Delete index
- Delete index template
- Delete index template (legacy)
- Exists
- Field usage stats
- Flush
- Force merge
- Get alias
- Get component template
- Get field mapping
- Get index
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Import dangling index
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists (legacy)
- List dangling indices
- Open index
- Refresh
- Resolve index
- Resolve cluster
- Rollover
- Shrink index
- Simulate index
- Simulate template
- Split index
- Unfreeze index
- Update index settings
- Update mapping
- Index lifecycle management APIs
- Create or update lifecycle policy
- Get policy
- Delete policy
- Move to step
- Remove policy
- Retry policy
- Get index lifecycle management status
- Explain lifecycle
- Start index lifecycle management
- Stop index lifecycle management
- Migrate indices, ILM policies, and legacy, composable and component templates to data tiers routing
- Inference APIs
- Delete inference API
- Get inference API
- Perform inference API
- Create inference API
- Stream inference API
- Update inference API
- AlibabaCloud AI Search inference service
- Amazon Bedrock inference service
- Anthropic inference service
- Azure AI studio inference service
- Azure OpenAI inference service
- Cohere inference service
- Elasticsearch inference service
- ELSER inference service
- Google AI Studio inference service
- Google Vertex AI inference service
- HuggingFace inference service
- Mistral inference service
- OpenAI inference service
- Watsonx inference service
- Info API
- Ingest APIs
- Licensing APIs
- Logstash APIs
- Machine learning APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendars
- Create datafeeds
- Create filters
- Delete calendars
- Delete datafeeds
- Delete events from calendar
- Delete filters
- Delete forecasts
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Estimate model memory
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get model snapshots
- Get model snapshot upgrade statistics
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Reset jobs
- Revert model snapshots
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filters
- Update jobs
- Update model snapshots
- Upgrade model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Delete data frame analytics jobs
- Evaluate data frame analytics
- Explain data frame analytics
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Preview data frame analytics
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Update data frame analytics jobs
- Machine learning trained model APIs
- Clear trained model deployment cache
- Create or update trained model aliases
- Create part of a trained model
- Create trained models
- Create trained model vocabulary
- Delete trained model aliases
- Delete trained models
- Get trained models
- Get trained models stats
- Infer trained model
- Start trained model deployment
- Stop trained model deployment
- Update trained model deployment
- Migration APIs
- Node lifecycle APIs
- Query rules APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Root API
- Script APIs
- Search APIs
- Search Application APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key cache
- Clear service account token caches
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Bulk create or update roles API
- Bulk delete roles API
- Create or update users
- Create service account tokens
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete service account token
- Delete users
- Disable users
- Enable users
- Enroll Kibana
- Enroll node
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Query Role
- Get service accounts
- Get service account credentials
- Get Security settings
- Get token
- Get user privileges
- Get users
- Grant API keys
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect prepare authentication
- OpenID Connect authenticate
- OpenID Connect logout
- Query API key information
- Query User
- Update API key
- Update Security settings
- Bulk update API keys
- SAML prepare authentication
- SAML authenticate
- SAML logout
- SAML invalidate
- SAML complete logout
- SAML service provider metadata
- SSL certificate
- Activate user profile
- Disable user profile
- Enable user profile
- Get user profiles
- Suggest user profile
- Update user profile data
- Has privileges user profile
- Create Cross-Cluster API key
- Update Cross-Cluster API key
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- SQL APIs
- Synonyms APIs
- Text structure APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Command line tools
- elasticsearch-certgen
- elasticsearch-certutil
- elasticsearch-create-enrollment-token
- elasticsearch-croneval
- elasticsearch-keystore
- elasticsearch-node
- elasticsearch-reconfigure-node
- elasticsearch-reset-password
- elasticsearch-saml-metadata
- elasticsearch-service-tokens
- elasticsearch-setup-passwords
- elasticsearch-shard
- elasticsearch-syskeygen
- elasticsearch-users
- Optimizations
- Troubleshooting
- Fix common cluster issues
- Diagnose unassigned shards
- Add a missing tier to the system
- Allow Elasticsearch to allocate the data in the system
- Allow Elasticsearch to allocate the index
- Indices mix index allocation filters with data tiers node roles to move through data tiers
- Not enough nodes to allocate all shard replicas
- Total number of shards for an index on a single node exceeded
- Total number of shards per node has been reached
- Troubleshooting corruption
- Fix data nodes out of disk
- Fix master nodes out of disk
- Fix other role nodes out of disk
- Start index lifecycle management
- Start Snapshot Lifecycle Management
- Restore from snapshot
- Troubleshooting broken repositories
- Addressing repeated snapshot policy failures
- Troubleshooting an unstable cluster
- Troubleshooting discovery
- Troubleshooting monitoring
- Troubleshooting transforms
- Troubleshooting Watcher
- Troubleshooting searches
- Troubleshooting shards capacity health issues
- Troubleshooting an unbalanced cluster
- Capture diagnostics
- Migration guide
- Release notes
- Elasticsearch version 8.17.1
- Elasticsearch version 8.17.0
- Elasticsearch version 8.16.2
- Elasticsearch version 8.16.1
- Elasticsearch version 8.16.0
- Elasticsearch version 8.15.5
- Elasticsearch version 8.15.4
- Elasticsearch version 8.15.3
- Elasticsearch version 8.15.2
- Elasticsearch version 8.15.1
- Elasticsearch version 8.15.0
- Elasticsearch version 8.14.3
- Elasticsearch version 8.14.2
- Elasticsearch version 8.14.1
- Elasticsearch version 8.14.0
- Elasticsearch version 8.13.4
- Elasticsearch version 8.13.3
- Elasticsearch version 8.13.2
- Elasticsearch version 8.13.1
- Elasticsearch version 8.13.0
- Elasticsearch version 8.12.2
- Elasticsearch version 8.12.1
- Elasticsearch version 8.12.0
- Elasticsearch version 8.11.4
- Elasticsearch version 8.11.3
- Elasticsearch version 8.11.2
- Elasticsearch version 8.11.1
- Elasticsearch version 8.11.0
- Elasticsearch version 8.10.4
- Elasticsearch version 8.10.3
- Elasticsearch version 8.10.2
- Elasticsearch version 8.10.1
- Elasticsearch version 8.10.0
- Elasticsearch version 8.9.2
- Elasticsearch version 8.9.1
- Elasticsearch version 8.9.0
- Elasticsearch version 8.8.2
- Elasticsearch version 8.8.1
- Elasticsearch version 8.8.0
- Elasticsearch version 8.7.1
- Elasticsearch version 8.7.0
- Elasticsearch version 8.6.2
- Elasticsearch version 8.6.1
- Elasticsearch version 8.6.0
- Elasticsearch version 8.5.3
- Elasticsearch version 8.5.2
- Elasticsearch version 8.5.1
- Elasticsearch version 8.5.0
- Elasticsearch version 8.4.3
- Elasticsearch version 8.4.2
- Elasticsearch version 8.4.1
- Elasticsearch version 8.4.0
- Elasticsearch version 8.3.3
- Elasticsearch version 8.3.2
- Elasticsearch version 8.3.1
- Elasticsearch version 8.3.0
- Elasticsearch version 8.2.3
- Elasticsearch version 8.2.2
- Elasticsearch version 8.2.1
- Elasticsearch version 8.2.0
- Elasticsearch version 8.1.3
- Elasticsearch version 8.1.2
- Elasticsearch version 8.1.1
- Elasticsearch version 8.1.0
- Elasticsearch version 8.0.1
- Elasticsearch version 8.0.0
- Elasticsearch version 8.0.0-rc2
- Elasticsearch version 8.0.0-rc1
- Elasticsearch version 8.0.0-beta1
- Elasticsearch version 8.0.0-alpha2
- Elasticsearch version 8.0.0-alpha1
- Dependencies and versions
Elastic SharePoint Online connector reference
editElastic SharePoint Online connector reference
editLooking for the SharePoint Server connector? See SharePoint Server reference.
The Elastic SharePoint Online connector is a connector for Microsoft SharePoint Online.
This connector is written in Python using the Elastic connector framework.
View the source code for this connector (branch 8.17, compatible with Elastic 8.17).
Elastic managed connector reference
editView Elastic managed connector reference
Availability and prerequisites
editThis connector is available as a managed connector in Elastic versions 8.9.0 and later. To use this connector natively in Elastic Cloud, satisfy all managed connector requirements.
This connector requires a subscription. View the requirements for this feature under the Elastic Search section of the Elastic Stack subscriptions page.
Usage
editTo use this connector as a managed connector, see Elastic managed connectors.
For additional operations, see Connectors UI in Kibana.
SharePoint prerequisites
editCreate SharePoint OAuth app
editBefore you can configure the connector, you must create an OAuth App in the SharePoint Online platform.
Your connector will authenticate to SharePoint as the registered OAuth application/client.
You’ll collect values (client ID
, tenant ID
, and client secret
) during this process that you’ll need for the configuration step in Kibana.
To get started, first log in to SharePoint Online and access your administrative dashboard. Ensure you are logged in as the Azure Portal service account.
Follow these steps:
- Sign in to https://portal.azure.com/ and click on Azure Active Directory.
- Locate App Registrations and Click New Registration.
- Give your app a name - like "Search".
- Leave the Redirect URIs blank for now.
- Register the application.
- Find and keep the Application (client) ID and Directory (tenant) ID handy.
-
Create a certificate and private key. This can, for example, be done by running
openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout azure_app.key -out azure_app.crt
command. Store both in a safe and secure place - Locate the Certificates by navigating to Client credentials: Certificates & Secrets.
- Select Upload certificate
-
Upload the certificate created in one of previous steps:
azure_app.crt
-
Set up the permissions the OAuth App will request from the Azure Portal service account.
- Navigate to API Permissions and click Add Permission.
-
Add application permissions until the list looks like the following:
Graph API - Sites.Selected - Files.Read.All - Group.Read.All - User.Read.All Sharepoint - Sites.Selected
If the
Comma-separated list of sites
configuration is set to*
or if a user enables the toggle buttonEnumerate all sites
, the connector requiresSites.Read.All
permission.
-
Grant admin consent, using the
Grant Admin Consent
link from the permissions screen. - Save the tenant name (i.e. Domain name) of Azure platform.
The connector requires application permissions. It does not support delegated permissions (scopes).
SharePoint permissions
editMicrosoft is retiring Azure Access Control Service (ACS). This affects permission configuration:
- Tenants created after November 1st, 2024: Certificate authentication is required
- Tenants created before November 1st, 2024: Secret-based authentication must be migrated to certificate authentication by April 2nd, 2026
Certificate Authentication
editThis authentication method does not require additional setup other than creating and uploading certificates to the OAuth App.
Secret Authentication
editThis method is only applicable to tenants created before November 1st, 2024. This method will be fully retired as of April 2nd, 2026.
Refer to the following documentation for setting SharePoint permissions.
-
To set
DisableCustomAppAuthentication
to false, connect to SharePoint using PowerShell and runset-spotenant -DisableCustomAppAuthentication $false
-
To assign full permissions to the tenant in SharePoint Online, go to the tenant URL in your browser. The URL follows this pattern:
https://<office_365_admin_tenant_URL>/_layouts/15/appinv.aspx
. This loads the SharePoint admin center page.- In the App ID box, enter the application ID that you recorded earlier, and then click Lookup. The application name will appear in the Title box.
- In the App Domain box, type <tenant_name>.onmicrosoft.com
-
In the App’s Permission Request XML box, type the following XML string:
<AppPermissionRequests AllowAppOnlyPolicy="true"> <AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl" /> <AppPermissionRequest Scope="http://sharepoint/social/tenant" Right="Read" /> </AppPermissionRequests>
Granting Sites.Selected
permissions
editTo configure Sites.Selected
permissions, follow these steps in the Azure Active Directory portal. These permissions enable precise access control to specific SharePoint sites.
- Sign in to the Azure Active Directory portal.
- Navigate to App registrations and locate the application created for the connector.
- Under API permissions, click Add permission.
-
Select Microsoft Graph > Application permissions, then add
Sites.Selected
. - Click Grant admin consent to approve the permission.
Refer to the official Microsoft documentation for managing permissions in Azure AD.
To assign access to specific SharePoint sites using Sites.Selected
:
- Use Microsoft Graph Explorer or PowerShell to grant access.
-
To fetch the site ID, run the following Graph API query:
GET https://graph.microsoft.com/v1.0/sites?select=webUrl,Title,Id&$search="<Name of the site>*"
This will return the
id
of the site. -
Use the
id
to assign read or write access:POST https://graph.microsoft.com/v1.0/sites/<siteId>/permissions { "roles": ["read"], // or "write" "grantedToIdentities": [ { "application": { "id": "<App_Client_ID>", "displayName": "<App_Display_Name>" } } ] }
When using the Comma-separated list of sites
configuration field, ensure the sites specified match those granted Sites.Selected
permission in SharePoint.
If the Comma-separated list of sites
field is set to *
or the Enumerate all sites
toggle is enabled, the connector will attempt to access all sites. This requires broader permissions, which are not supported with Sites.Selected
.
Compatibility
editThis connector is compatible with SharePoint Online.
Configuration
editUse the following configuration fields to set up the connector:
- Tenant ID
- The tenant id for the Azure account hosting the Sharepoint Online instance.
- Tenant Name
- The tenant name for the Azure account hosting the Sharepoint Online instance.
- Client ID
- The client id to authenticate with SharePoint Online.
- Authentication Method
-
Authentication method to use to connector to Sharepoint Online and Rest APIs.
secret
is deprecated andcertificate
is recommended. - Secret value
-
The secret value to authenticate with SharePoint Online, if Authentication Method:
secret
is chosen. - Content of certificate file
-
Content of certificate file if Authentication Method:
certificate
is chosen. - Content of private key file
-
Content of private key file if Authentication Method:
certificate
is chosen. - Comma-separated list of sites
-
List of site collection names or paths to fetch from SharePoint. When enumerating all sites, these values should be the names of the sites. Use
*
to include all available sites. Examples:-
collection1
-
collection1,sub-collection
-
*
When not enumerating all sites, these values should be the paths (URL after
/sites/
) of the sites. Examples: -
collection1
-
collection1,collection1/sub-collection
-
- Enumerate all sites?
-
If enabled, the full list of all sites will be fetched from the API, in bulk, and will be filtered down to match the configured list of site names.
If disabled, each path in the configured list of site paths will be fetched individually from the API.
When disabled,
*
is not a valid configuration forComma-separated list of sites
. Enabling this configuration is most useful when syncing large numbers (more than total/200) of sites. This is because, at high volumes, it is more efficient to fetch sites in bulk. When syncing fewer sites, disabling this configuration can result in improved performance. This is because, at low volumes, it is more efficient to only fetch the sites that you need. - Fetch sub-sites of configured sites?
- Whether sub-sites of the configured site(s) should be automatically fetched. This option is only available when not enumerating all sites (see above).
- Enable document level security
-
Toggle to enable document level security (DLS). When enabled, full and incremental 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.Once enabled, the following granular permissions toggles will be available:
- Fetch drive item permissions: Enable this option to fetch drive item specific permissions.
- Fetch unique page permissions: Enable this option to fetch unique page permissions. If this setting is disabled a page will inherit permissions from its parent site.
- Fetch unique list permissions: Enable this option to fetch unique list permissions. If this setting is disabled a list will inherit permissions from its parent site.
-
Fetch unique list item permissions: Enable this option to fetch unique list item permissions. If this setting is disabled a list item will inherit permissions from its parent site.
If left empty the default value
true
will be used for these granular permissions toggles. Note that these settings may increase sync times.
Documents and syncs
editThe connector syncs the following SharePoint object types:
- Sites (and subsites)
- Lists
- List items and attachment content
- Document libraries and attachment content (including web pages)
- Content from files bigger than 10 MB won’t be extracted. (Self-managed connectors can use the self-managed local extraction service to handle larger binary files.)
- Permissions are not synced by default. Enable document-level security (DLS) to sync permissions.
Making Sharepoint Site Pages Web Part content searchable
If you’re using Web Parts on Sharepoint Site Pages and want to make this content searchable, you’ll need to consult the official documentation.
We recommend setting isHtmlString
to True for all Web Parts that need to be searchable.
Limitations
edit- The connector does not currently sync content from Teams-connected sites.
Sync rules
editBasic sync rules are identical for all connectors and are available by default. For more information read Types of sync rule.
Advanced sync rules
editA full sync is required for advanced sync rules to take effect.
The following section describes advanced sync rules for this connector. Advanced sync rules are defined through a source-specific DSL JSON snippet.
Advanced rules for the Sharepoint Online connector enable you to avoid extracting and syncing older data that might no longer be relevant for search.
Example:
{ "skipExtractingDriveItemsOlderThan": 60 }
This rule will not extract content of any drive items (files in document libraries) that haven’t been modified for 60 days or more.
Limitations of sync rules with incremental syncs
Changing sync rules after Sharepoint Online content has already been indexed can bring unexpected results, when using incremental syncs.
Incremental syncs ensure updates from 3rd-party system, but do not modify existing documents in the index.
To avoid these issues, run a full sync after changing sync rules (basic or advanced).
Let’s take a look at several examples where incremental syncs might lead to inconsistent data on your index.
Example: Restrictive basic sync rule added after a full sync
Imagine your Sharepoint Online drive contains the following drive items:
/Documents/Report.doc /Documents/Spreadsheet.xls /Presentations/Q4-2020-Report.pdf /Presentations/Q4-2020-Report-Data.xls /Personal/Documents/Sales.xls
After a sync, all these drive items will be stored on your Elasticsearch index. Let’s add a basic sync rule, filtering files by their path:
Exclude WHERE path CONTAINS "Documents"
These filtering rules will exclude all files with "Documents" in their path, leaving only files in /Presentations
directory:
/Presentations/Q4-2020-Report.pdf /Presentations/Q4-2020-Report-Data.xls
If no files were changed, incremental sync will not receive information about changes from Sharepoint Online and won’t be able to delete any files, leaving the index in the same state it was before the sync.
After a full sync, the index will be updated and files that are excluded by sync rules will be removed.
Example: Restrictive basic sync rules removed after a full sync
Imagine that Sharepoint Online drive has the following drive items:
/Documents/Report.doc /Documents/Spreadsheet.xls /Presentations/Q4-2020-Report.pdf /Presentations/Q4-2020-Report-Data.xls /Personal/Documents/Sales.xls
Before doing a sync, we add a restrictive basic filtering rule:
Exclude WHERE path CONTAINS "Documents"
After a full sync, the index will contain only files in the /Presentations
directory:
/Presentations/Q4-2020-Report.pdf /Presentations/Q4-2020-Report-Data.xls
Afterwards, we can remove the filtering rule and run an incremental sync. If no changes happened to the files, incremental sync will not mirror these changes in the Elasticsearch index, because Sharepoint Online will not report any changes to the items. Only a full sync will include the items previously ignored by the sync rule.
Example: Advanced sync rules edge case
Advanced sync rules can be applied to limit which documents will have content extracted. For example, it’s possible to set a rule so that documents older than 180 days won’t have content extracted.
However, there is an edge case. Imagine a document that is 179 days old and its content is extracted and indexed into Elasticsearch. After 2 days, this document will be 181 days old. Since this document was already ingested it will not be modified. Therefore, the content will not be removed from the index, following an incremental sync.
In this situation, if you want older documents to be removed, you will need to clean the index up manually. For example, you can manually run an Elasticsearch query that removes drive item content older than 180 days:
resp = client.update_by_query( index="INDEX_NAME", conflicts="proceed", query={ "bool": { "filter": [ { "match": { "object_type": "drive_item" } }, { "exists": { "field": "file" } }, { "range": { "lastModifiedDateTime": { "lte": "now-180d" } } } ] } }, script={ "source": "ctx._source.body = ''", "lang": "painless" }, ) print(resp)
const response = await client.updateByQuery({ index: "INDEX_NAME", conflicts: "proceed", query: { bool: { filter: [ { match: { object_type: "drive_item", }, }, { exists: { field: "file", }, }, { range: { lastModifiedDateTime: { lte: "now-180d", }, }, }, ], }, }, script: { source: "ctx._source.body = ''", lang: "painless", }, }); console.log(response);
POST INDEX_NAME/_update_by_query?conflicts=proceed { "query": { "bool": { "filter": [ { "match": { "object_type": "drive_item" } }, { "exists": { "field": "file" } }, { "range": { "lastModifiedDateTime": { "lte": "now-180d" } } } ] } }, "script": { "source": "ctx._source.body = ''", "lang": "painless" } }
Document-level security
editDocument-level security (DLS) enables you to restrict access to documents based on a user’s permissions. This feature is available by default for this connector.
Refer to configuration on this page for how to enable DLS for this connector.
Refer to DLS in Search Applications to learn how to ingest data from SharePoint Online with DLS enabled, when building a search application.
Content extraction
editDefault content extraction
editThe default content extraction service is powered by the Enterprise Search default ingest pipeline. (See Ingest pipelines for Search indices.)
See Content extraction.
Local content extraction (for large files)
editThe SharePoint Online self-managed connector supports large file content extraction (> 100MB). This requires:
- A self-managed deployment of the Elastic Text Extraction Service.
- Text extraction to be disabled in the default ingest pipeline settings.
Refer to local content extraction for more information.
Known issues
edit-
Documents failing to sync due to SharePoint file and folder limits
SharePoint has limits on the number of files and folders that can be synced. You might encounter an error like the following written to the body of documents that failed to sync:
The file size exceeds the allowed limit. CorrelationId: fdb36977-7cb8-4739-992f-49878ada6686, UTC DateTime: 4/21/2022 11:24:22 PM
Refer to SharePoint documentation for more information about these limits.
-
Syncing a large number of files
The connector will fail to download files from folders that contain more than 5000 files. The List View Threshold (default 5000) is a limit that prevents operations with a high performance impact on the SharePoint Online environment.
Workaround: Reduce batch size to avoid this issue.
-
Syncing large files
SharePoint has file size limits, but these are configurable.
Workaround: Increase the file size limit. Refer to SharePoint documentation for more information.
-
Deleted documents counter is not updated during incremental syncs
If the configuration
Enumerate All Sites?
is enabled, incremental syncs may not behave as expected. Drive Item documents that were deleted between incremental syncs may not be detected as deleted.Workaround: Disable
Enumerate All Sites?
, and configure full site paths for all desired sites.
-
Refer to Known issues for a list of known issues for all connectors.
Troubleshooting
editSee Troubleshooting.
Security
editSee Security.
Self-managed connector
editView self-managed connector reference
Availability and prerequisites
editThis connector is available as a self-managed self-managed connector. To use this connector as a self-managed connector, satisfy all self-managed connector requirements.
This connector requires a subscription. View the requirements for this feature under the Elastic Search section of the Elastic Stack subscriptions page.
Usage
editTo use this connector as a self-managed connector, see Self-managed connectors For additional operations, see Connectors UI in Kibana.
SharePoint prerequisites
editCreate SharePoint OAuth app
editBefore you can configure the connector, you must create an OAuth App in the SharePoint Online platform.
Your connector will authenticate to SharePoint as the registered OAuth application/client.
You’ll collect values (client ID
, tenant ID
, and client secret
) during this process that you’ll need for the configuration step in Kibana.
To get started, first log in to SharePoint Online and access your administrative dashboard. Ensure you are logged in as the Azure Portal service account.
Follow these steps:
- Sign in to https://portal.azure.com/ and click on Azure Active Directory.
- Locate App Registrations and Click New Registration.
- Give your app a name - like "Search".
- Leave the Redirect URIs blank for now.
- Register the application.
- Find and keep the Application (client) ID and Directory (tenant) ID handy.
-
Create a certificate and private key. This can, for example, be done by running
openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout azure_app.key -out azure_app.crt
command. Store both in a safe and secure place - Locate the Certificates by navigating to Client credentials: Certificates & Secrets.
- Select Upload certificate
-
Upload the certificate created in one of previous steps:
azure_app.crt
-
Set up the permissions the OAuth App will request from the Azure Portal service account.
- Navigate to API Permissions and click Add Permission.
-
Add application permissions until the list looks like the following:
Graph API - Sites.Selected - Files.Read.All - Group.Read.All - User.Read.All Sharepoint - Sites.Selected
If the
Comma-separated list of sites
configuration is set to*
or if a user enables the toggle buttonEnumerate all sites
, the connector requiresSites.Read.All
permission.
-
Grant admin consent, using the
Grant Admin Consent
link from the permissions screen. - Save the tenant name (i.e. Domain name) of Azure platform.
The connector requires application permissions. It does not support delegated permissions (scopes).
SharePoint permissions
editMicrosoft is retiring Azure Access Control Service (ACS). This affects permission configuration: * Tenants created after November 1st, 2024: Certificate authentication is required * Tenants created before November 1st, 2024: Secret-based authentication must be migrated to certificate authentication by April 2nd, 2026
Certificate Authentication
editThis authentication method does not require additional setup other than creating and uploading certificates to the OAuth App.
Secret Authentication
editThis method is only applicable to tenants created before November 1st, 2024. This method will be fully retired as of April 2nd, 2026.
Refer to the following documentation for setting SharePoint permissions.
-
To set
DisableCustomAppAuthentication
to false, connect to SharePoint using PowerShell and runset-spotenant -DisableCustomAppAuthentication $false
-
To assign full permissions to the tenant in SharePoint Online, go to the tenant URL in your browser. The URL follows this pattern:
https://<office_365_admin_tenant_URL>/_layouts/15/appinv.aspx
. This loads the SharePoint admin center page.- In the App ID box, enter the application ID that you recorded earlier, and then click Lookup. The application name will appear in the Title box.
- In the App Domain box, type <tenant_name>.onmicrosoft.com
-
In the App’s Permission Request XML box, type the following XML string:
<AppPermissionRequests AllowAppOnlyPolicy="true"> <AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl" /> <AppPermissionRequest Scope="http://sharepoint/social/tenant" Right="Read" /> </AppPermissionRequests>
Granting Sites.Selected
permissions
editTo configure Sites.Selected
permissions, follow these steps in the Azure Active Directory portal. These permissions enable precise access control to specific SharePoint sites.
- Sign in to the Azure Active Directory portal.
- Navigate to App registrations and locate the application created for the connector.
- Under API permissions, click Add permission.
-
Select Microsoft Graph > Application permissions, then add
Sites.Selected
. - Click Grant admin consent to approve the permission.
Refer to the official Microsoft documentation for managing permissions in Azure AD.
To assign access to specific SharePoint sites using Sites.Selected
:
- Use Microsoft Graph Explorer or PowerShell to grant access.
-
To fetch the site ID, run the following Graph API query:
GET https://graph.microsoft.com/v1.0/sites?select=webUrl,Title,Id&$search="<Name of the site>*"
This will return the
id
of the site. -
Use the
id
to assign read or write access:POST https://graph.microsoft.com/v1.0/sites/<siteId>/permissions { "roles": ["read"], // or "write" "grantedToIdentities": [ { "application": { "id": "<App_Client_ID>", "displayName": "<App_Display_Name>" } } ] }
When using the Comma-separated list of sites
configuration field, ensure the sites specified match those granted Sites.Selected
permission in SharePoint.
If the Comma-separated list of sites
field is set to *
or the Enumerate all sites
toggle is enabled, the connector will attempt to access all sites. This requires broader permissions, which are not supported with Sites.Selected
.
Compatibility
editThis connector is compatible with SharePoint Online.
Configuration
editWhen using the self-managed connector workflow, initially these fields will use the default configuration set in the connector source code.
These are set in the get_default_configuration
function definition.
These configurable fields will be rendered with their respective labels in the Kibana UI. Once connected, you’ll be able to update these values in Kibana.
Use the following configuration fields to set up the connector:
-
tenant_id
- The tenant id for the Azure account hosting the Sharepoint Online instance.
-
tenant_name
- The tenant name for the Azure account hosting the Sharepoint Online instance.
-
client_id
- The client id to authenticate with SharePoint Online.
-
auth_method
-
Authentication method to use to connector to Sharepoint Online and Rest APIs.
secret
is deprecated andcertificate
is recommended. -
secret_value
-
The secret value to authenticate with SharePoint Online, if auth_method:
secret
is chosen. -
certificate
-
Content of certificate file if auth_method:
certificate
is chosen. -
private_key
-
Content of private key file if auth_method:
certificate
is chosen. -
site_collections
-
List of site collection names or paths to fetch from SharePoint. When enumerating all sites, these values should be the names of the sites. Use
*
to include all available sites. Examples:-
collection1
-
collection1,sub-collection
-
*
When not enumerating all sites, these values should be the paths (URL after
/sites/
) of the sites. Examples: -
collection1
-
collection1,collection1/sub-collection
-
-
enumerate_all_sites
-
If enabled, the full list of all sites will be fetched from the API, in bulk, and will be filtered down to match the configured list of site names. If disabled, each path in the configured list of site paths will be fetched individually from the API. Enabling this configuration is most useful when syncing large numbers (more than total/200) of sites. This is because, at high volumes, it is more efficient to fetch sites in bulk. When syncing fewer sites, disabling this configuration can result in improved performance. This is because, at low volumes, it is more efficient to only fetch the sites that you need.
When disabled,
*
is not a valid configuration forComma-separated list of sites
. -
fetch_subsites
- Whether sub-sites of the configured site(s) should be automatically fetched. This option is only available when not enumerating all sites (see above).
-
use_text_extraction_service
-
Toggle to enable local text extraction service for documents.
Requires a separate deployment of the Elastic Text Extraction Service.
Requires that ingest pipeline settings disable text extraction.
Default value is
False
. -
use_document_level_security
-
Toggle to enable document level security (DLS). When enabled, full and incremental 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.Once enabled, the following granular permissions toggles will be available:
- Fetch drive item permissions: Enable this option to fetch drive item specific permissions.
- Fetch unique page permissions: Enable this option to fetch unique page permissions. If this setting is disabled a page will inherit permissions from its parent site.
- Fetch unique list permissions: Enable this option to fetch unique list permissions. If this setting is disabled a list will inherit permissions from its parent site.
-
Fetch unique list item permissions: Enable this option to fetch unique list item permissions. If this setting is disabled a list item will inherit permissions from its parent site.
If left empty the default value
true
will be used for these granular permissions toggles. Note that these settings may increase sync times.
Deployment using Docker
editYou can deploy the SharePoint Online connector as a self-managed connector using Docker. Follow these instructions.
Step 1: Download sample configuration file
Download the sample configuration file. You can either download it manually or run the following command:
curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-config/config.yml
Remember to update the --output
argument value if your directory name is different, or you want to use a different config file name.
Step 2: Update the configuration file for your self-managed connector
Update the configuration file with the following settings to match your environment:
-
elasticsearch.host
-
elasticsearch.api_key
-
connectors
If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:
# When connecting to your cloud deployment you should edit the host value elasticsearch.host: http://host.docker.internal:9200 elasticsearch.api_key: <ELASTICSEARCH_API_KEY> connectors: - connector_id: <CONNECTOR_ID_FROM_KIBANA> service_type: sharepoint_online api_key: <CONNECTOR_API_KEY_FROM_KIBANA> # Optional. If not provided, the connector will use the elasticsearch.api_key instead
Using the elasticsearch.api_key
is the recommended authentication method. However, you can also use elasticsearch.username
and elasticsearch.password
to authenticate with your Elasticsearch instance.
Note: You can change other default configurations by simply uncommenting specific settings in the configuration file and modifying their values.
Step 3: Run the Docker image
Run the Docker image with the Connector Service using the following command:
docker run \ -v ~/connectors-config:/config \ --network "elastic" \ --tty \ --rm \ docker.elastic.co/enterprise-search/elastic-connectors:8.17.0.0 \ /app/bin/elastic-ingest \ -c /config/config.yml
Refer to DOCKER.md
in the elastic/connectors
repo for more details.
Find all available Docker images in the official registry.
We also have a quickstart self-managed option using Docker Compose, so you can spin up all required services at once: Elasticsearch, Kibana, and the connectors service.
Refer to this README in the elastic/connectors
repo for more information.
Documents and syncs
editThe connector syncs the following SharePoint object types:
- Sites (and subsites)
- Lists
- List items and attachment content
- Document libraries and attachment content (including web pages)
Making Sharepoint Site Pages Web Part content searchable
If you’re using Web Parts on Sharepoint Site Pages and want to make this content searchable, you’ll need to consult the official documentation.
We recommend setting isHtmlString
to True for all Web Parts that need to be searchable.
- Content from files bigger than 10 MB won’t be extracted by default. Use the self-managed local extraction service to handle larger binary files.
- Permissions are not synced by default. Enable document-level security (DLS) to sync permissions.
Limitations
edit- The connector does not currently sync content from Teams-connected sites.
Sync rules
editBasic sync rules are identical for all connectors and are available by default. For more information read Types of sync rule.
Advanced sync rules
editA full sync is required for advanced sync rules to take effect.
The following section describes advanced sync rules for this connector. Advanced sync rules are defined through a source-specific DSL JSON snippet.
Advanced rules for the Sharepoint Online connector enable you to avoid extracting and syncing older data that might no longer be relevant for search.
Example:
{ "skipExtractingDriveItemsOlderThan": 60 }
This rule will not extract content of any drive items (files in document libraries) that haven’t been modified for 60 days or more.
Limitations of sync rules with incremental syncs
Changing sync rules after Sharepoint Online content has already been indexed can bring unexpected results, when using incremental syncs.
Incremental syncs ensure updates from 3rd-party system, but do not modify existing documents in the index.
To avoid these issues, run a full sync after changing sync rules (basic or advanced).
Let’s take a look at several examples where incremental syncs might lead to inconsistent data on your index.
Example: Restrictive basic sync rule added after a full sync
Imagine your Sharepoint Online drive contains the following drive items:
/Documents/Report.doc /Documents/Spreadsheet.xls /Presentations/Q4-2020-Report.pdf /Presentations/Q4-2020-Report-Data.xls /Personal/Documents/Sales.xls
After a sync, all these drive items will be stored on your Elasticsearch index. Let’s add a basic sync rule, filtering files by their path:
Exclude WHERE path CONTAINS "Documents"
These filtering rules will exclude all files with "Documents" in their path, leaving only files in /Presentations
directory:
/Presentations/Q4-2020-Report.pdf /Presentations/Q4-2020-Report-Data.xls
If no files were changed, incremental sync will not receive information about changes from Sharepoint Online and won’t be able to delete any files, leaving the index in the same state it was before the sync.
After a full sync, the index will be updated and files that are excluded by sync rules will be removed.
Example: Restrictive basic sync rules removed after a full sync
Imagine that Sharepoint Online drive has the following drive items:
/Documents/Report.doc /Documents/Spreadsheet.xls /Presentations/Q4-2020-Report.pdf /Presentations/Q4-2020-Report-Data.xls /Personal/Documents/Sales.xls
Before doing a sync, we add a restrictive basic filtering rule:
Exclude WHERE path CONTAINS "Documents"
After a full sync, the index will contain only files in the /Presentations
directory:
/Presentations/Q4-2020-Report.pdf /Presentations/Q4-2020-Report-Data.xls
Afterwards, we can remove the filtering rule and run an incremental sync. If no changes happened to the files, incremental sync will not mirror these changes in the Elasticsearch index, because Sharepoint Online will not report any changes to the items. Only a full sync will include the items previously ignored by the sync rule.
Example: Advanced sync rules edge case
Advanced sync rules can be applied to limit which documents will have content extracted. For example, it’s possible to set a rule so that documents older than 180 days won’t have content extracted.
However, there is an edge case. Imagine a document that is 179 days old and its content is extracted and indexed into Elasticsearch. After 2 days, this document will be 181 days old. Since this document was already ingested it will not be modified. Therefore, the content will not be removed from the index, following an incremental sync.
In this situation, if you want older documents to be removed, you will need to clean the index up manually. For example, you can manually run an Elasticsearch query that removes drive item content older than 180 days:
resp = client.update_by_query( index="INDEX_NAME", conflicts="proceed", query={ "bool": { "filter": [ { "match": { "object_type": "drive_item" } }, { "exists": { "field": "file" } }, { "range": { "lastModifiedDateTime": { "lte": "now-180d" } } } ] } }, script={ "source": "ctx._source.body = ''", "lang": "painless" }, ) print(resp)
const response = await client.updateByQuery({ index: "INDEX_NAME", conflicts: "proceed", query: { bool: { filter: [ { match: { object_type: "drive_item", }, }, { exists: { field: "file", }, }, { range: { lastModifiedDateTime: { lte: "now-180d", }, }, }, ], }, }, script: { source: "ctx._source.body = ''", lang: "painless", }, }); console.log(response);
POST INDEX_NAME/_update_by_query?conflicts=proceed { "query": { "bool": { "filter": [ { "match": { "object_type": "drive_item" } }, { "exists": { "field": "file" } }, { "range": { "lastModifiedDateTime": { "lte": "now-180d" } } } ] } }, "script": { "source": "ctx._source.body = ''", "lang": "painless" } }
Document-level security
editDocument-level security (DLS) enables you to restrict access to documents based on a user’s permissions. This feature is available by default for this connector.
Refer to configuration on this page for how to enable DLS for this connector.
Refer to DLS in Search Applications to learn how to ingest data from SharePoint Online with DLS enabled, when building a search application.
Content extraction
editDefault content extraction
editThe default content extraction service is powered by the Enterprise Search default ingest pipeline. (See Ingest pipelines for Search indices.)
See Content extraction.
Local content extraction (for large files)
editThe SharePoint Online self-managed connector supports large file content extraction (> 100MB). This requires:
- A self-managed deployment of the Elastic Text Extraction Service.
- Text extraction to be disabled in the default ingest pipeline settings.
Refer to local content extraction for more information.
End-to-end testing
editThe connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.
To perform E2E testing for the SharePoint Online connector, run the following command:
$ make ftest NAME=sharepoint_online
For faster tests, add the DATA_SIZE=small
flag:
make ftest NAME=sharepoint_online DATA_SIZE=small
Known issues
edit-
Documents failing to sync due to SharePoint file and folder limits
SharePoint has limits on the number of files and folders that can be synced. You might encounter an error like the following written to the body of documents that failed to sync:
The file size exceeds the allowed limit. CorrelationId: fdb36977-7cb8-4739-992f-49878ada6686, UTC DateTime: 4/21/2022 11:24:22 PM
Refer to SharePoint documentation for more information about these limits.
-
Syncing a large number of files
The connector will fail to download files from folders that contain more than 5000 files. The List View Threshold (default 5000) is a limit that prevents operations with a high performance impact on the SharePoint Online environment.
Workaround: Reduce batch size to avoid this issue.
-
Syncing large files
SharePoint has file size limits, but these are configurable.
Workaround: Increase the file size limit. Refer to SharePoint documentation for more information.
-
Deleted documents counter is not updated during incremental syncs
If the configuration
Enumerate All Sites?
is enabled, incremental syncs may not behave as expected. Drive Item documents that were deleted between incremental syncs may not be detected as deleted.Workaround: Disable
Enumerate All Sites?
, and configure full site paths for all desired sites.
-
Refer to Known issues for a list of known issues for all connectors.
Troubleshooting
editSee Troubleshooting.
Security
editSee Security.
On this page
- Elastic managed connector reference
- Availability and prerequisites
- Usage
- SharePoint prerequisites
- Create SharePoint OAuth app
- SharePoint permissions
- Certificate Authentication
- Secret Authentication
- Granting
Sites.Selected
permissions - Compatibility
- Configuration
- Documents and syncs
- Limitations
- Sync rules
- Advanced sync rules
- Document-level security
- Content extraction
- Default content extraction
- Local content extraction (for large files)
- Known issues
- Troubleshooting
- Security
- Self-managed connector
- Availability and prerequisites
- Usage
- SharePoint prerequisites
- Create SharePoint OAuth app
- SharePoint permissions
- Certificate Authentication
- Secret Authentication
- Granting
Sites.Selected
permissions - Compatibility
- Configuration
- Deployment using Docker
- Documents and syncs
- Limitations
- Sync rules
- Advanced sync rules
- Document-level security
- Content extraction
- Default content extraction
- Local content extraction (for large files)
- End-to-end testing
- Known issues
- Troubleshooting
- Security