Elastic OneDrive connector referenceedit

The Elastic OneDrive connector is a connector for OneDrive. This connector is written in Python using the Elastic connector framework.

View the source code for this connector (branch 8.11, compatible with Elastic 8.11).

Native connector (Elastic Cloud)edit

View native connector reference

Availability and prerequisitesedit

This connector is available as a native connector as of Elastic version 8.11.0.

To use this connector natively in Elastic Cloud, satisfy all native connector requirements.

This connector is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Usageedit

To use this connector natively in Elastic Cloud, see Native connectors.

For additional operations, see Using connectors.

Connecting to OneDriveedit

To connect to OneDrive you need to create an Azure Active Directory application and service principal that can access resources.

Follow these steps:

  1. Go to the Azure portal and sign in with your Azure account.
  2. Navigate to the Azure Active Directory service.
  3. Select App registrations from the left-hand menu.
  4. Click on the New registration button to register a new application.
  5. Provide a name for your app, and optionally select the supported account types (e.g., single tenant, multi-tenant).
  6. Click on the Register button to create the app registration.
  7. After the registration is complete, you will be redirected to the app’s overview page. Take note of the Application (client) ID value, as you’ll need it later.
  8. Scroll down to the API permissions section and click on the Add a permission button.
  9. In the Request API permissions pane, select Microsoft Graph as the API.
  10. Choose the application permissions and select the following permissions under the Application tab: User.Read.All, File.Read.All
  11. Click on the Add permissions button to add the selected permissions to your app. Finally, click on the Grant admin consent button to grant the required permissions to the app. This step requires administrative privileges. NOTE: If you are not an admin, you need to request the Admin to grant consent via their Azure Portal.
  12. Click on Certificates & Secrets tab. Go to Client Secrets. Generate a new client secret and keep a note of the string present under Value column.

Configurationedit

The following configuration fields are required:

Azure application Client ID

Unique identifier for your Azure Application, found on the app’s overview page. Example:

  • ab123453-12a2-100a-1123-93fd09d67394
Azure application Client Secret

String value that the application uses to prove its identity when requesting a token, available under the Certificates & Secrets tab of your Azure application menu. Example:

  • eyav1~12aBadIg6SL-STDfg102eBfCGkbKBq_Ddyu
Azure application Tenant ID

Unique identifier of your Azure Active Directory instance. Example:

  • 123a1b23-12a3-45b6-7c8d-fc931cfb448d
Enable document level security

Toggle to enable document level security. 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.

Enabling DLS for your connector will cause a significant performance degradation, as the API calls to the data source required for this functionality are rate limited. This impacts the speed at which your content can be retrieved.

Content Extractionedit

Refer to Content extraction for more details.

Documents and syncsedit

The connector syncs the following objects and entities:

  • Files

    • Includes metadata such as file name, path, size, content, etc.
  • Folders
  • Files bigger than 10 MB won’t be extracted.
  • Permissions are not synced by default. You must first enable DLS. Otherwise, all documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.

Document level securityedit

Document level security (DLS) enables you to restrict access to documents based on a user’s permissions. This feature is available by default for the OneDrive connector. See Configuration for how to enable DLS for this connector.

Refer to document level security for more details about this feature.

Refer to DLS in Search Applications to learn how to ingest data with DLS enabled, when building a search application.

Sync rulesedit

Basic sync rules are identical for all connectors and are available by default. For more information read Types of sync rule.

Advanced sync rulesedit

This connector supports advanced sync rules for remote filtering. These rules cover complex query-and-filter scenarios that cannot be expressed with basic sync rules. Advanced sync rules are defined through a source-specific DSL JSON snippet.

A full sync is required for advanced sync rules to take effect.

Here are a few examples of advanced sync rules for this connector.

Example 1edit

This rule skips indexing for files with .xlsx and .docx extensions. All other files and folders will be indexed.

[
  {
    "skipFilesWithExtensions": [".xlsx" , ".docx"]
  }
]
Example 2edit

This rule focuses on indexing files and folders owned by user1-domain@onmicrosoft.com and user2-domain@onmicrosoft.com but excludes files with .py extension.

[
  {
    "owners": ["user1-domain@onmicrosoft.com", "user2-domain@onmicrosoft.com"],
    "skipFilesWithExtensions": [".py"]
  }
]
Example 3edit

This rule indexes only the files and folders directly inside the root folder, excluding any .md files.

[
  {
    "skipFilesWithExtensions": [".md"],
    "parentPathPattern": "/drive/root:"
  }
]
Example 4edit

This rule indexes files and folders owned by user1-domain@onmicrosoft.com and user3-domain@onmicrosoft.com that are directly inside the abc folder, which is a subfolder of any folder under the hello directory in the root. Files with extensions .pdf and .py are excluded.

[
  {
    "owners": ["user1-domain@onmicrosoft.com", "user3-domain@onmicrosoft.com"],
    "skipFilesWithExtensions": [".pdf", ".py"],
    "parentPathPattern": "/drive/root:/hello/**/abc"
  }
]
Example 5edit

This example contains two rules. The first rule indexes all files and folders owned by user1-domain@onmicrosoft.com and user2-domain@onmicrosoft.com. The second rule indexes files for all other users, but skips files with a .py extension.

[
  {
    "owners": ["user1-domain@onmicrosoft.com", "user2-domain@onmicrosoft.com"]
  },
  {
    "skipFilesWithExtensions": [".py"]
  }
]
Example 6edit

This example contains two rules. The first rule indexes all files owned by user1-domain@onmicrosoft.com and user2-domain@onmicrosoft.com, excluding .md files. The second rule indexes files and folders recursively inside the abc folder.

[
  {
    "owners": ["user1-domain@onmicrosoft.com", "user2-domain@onmicrosoft.com"],
    "skipFilesWithExtensions": [".md"]
  },
  {
    "parentPathPattern": "/drive/root:/abc/**"
  }
]

Content Extractionedit

See Content extraction.

Known issuesedit

  • Enabling document-level security impacts performance.

    Enabling DLS for your connector will cause a significant performance degradation, as the API calls to the data source required for this functionality are rate limited. This impacts the speed at which your content can be retrieved.

Refer to Known issues for a list of known issues for all connectors.

Troubleshootingedit

See Troubleshooting.

Securityedit

See Security.

Connector client (self-managed)edit

View connector client reference

Availability and prerequisitesedit

This connector is available as a self-managed connector client.

This connector client is compatible with Elastic versions 8.10.0+.

To use this connector, satisfy all connector client requirements.

This connector is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

Usageedit

Self-manage this connector

Because this client is available as a native connector, you’ll first need to convert to a connector client in the Kibana UI. This action is irreversible. Use the Convert connector button on the right-hand side of the configuration page.

For additional operations, see Using connectors.

Connecting to OneDriveedit

To connect to OneDrive you need to create an Azure Active Directory application and service principal that can access resources.

Follow these steps:

  1. Go to the Azure portal and sign in with your Azure account.
  2. Navigate to the Azure Active Directory service.
  3. Select App registrations from the left-hand menu.
  4. Click on the New registration button to register a new application.
  5. Provide a name for your app, and optionally select the supported account types (e.g., single tenant, multi-tenant).
  6. Click on the Register button to create the app registration.
  7. After the registration is complete, you will be redirected to the app’s overview page. Take note of the Application (client) ID value, as you’ll need it later.
  8. Scroll down to the API permissions section and click on the Add a permission button.
  9. In the Request API permissions pane, select Microsoft Graph as the API.
  10. Choose the application permissions and select the following permissions under the Application tab: User.Read.All, File.Read.All
  11. Click on the Add permissions button to add the selected permissions to your app. Finally, click on the Grant admin consent button to grant the required permissions to the app. This step requires administrative privileges. NOTE: If you are not an admin, you need to request the Admin to grant consent via their Azure Portal.
  12. Click on Certificates & Secrets tab. Go to Client Secrets. Generate a new client secret and keep a note of the string present under Value column.

Deployment using Dockeredit

Connector clients are run on your own infrastructure.

You can deploy the OneDrive connector as a self-managed connector client 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 --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: onedrive
    api_key: <CONNECTOR_API_KEY_FROM_KIBANA>

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.11.4.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.

Configurationedit

The following configuration fields are required:

client_id

Azure application Client ID, unique identifier for your Azure Application, found on the app’s overview page. Example:

  • ab123453-12a2-100a-1123-93fd09d67394
client_secret

Azure application Client Secret, string value that the application uses to prove its identity when requesting a token. Available under the Certificates & Secrets tab of your Azure application menu. Example:

  • eyav1~12aBadIg6SL-STDfg102eBfCGkbKBq_Ddyu
tenant_id

Azure application Tenant ID: unique identifier of your Azure Active Directory instance. Example:

  • 123a1b23-12a3-45b6-7c8d-fc931cfb448d
retry_count
The number of retry attempts after failed request to OneDrive. Default value is 3.
use_document_level_security

Toggle to enable document level security. 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.

    Enabling DLS for your connector will cause a significant performance degradation, as the API calls to the data source required for this functionality are rate limited. This impacts the speed at which your content can be retrieved.

use_text_extraction_service
Requires a separate deployment of the Elastic Text Extraction Service. Requires that ingest pipeline settings disable text extraction. Default value is False.

Content Extractionedit

Refer to Content extraction for more details.

Documents and syncsedit

The connector syncs the following objects and entities:

  • Files

    • Includes metadata such as file name, path, size, content, etc.
  • Folders
  • Files bigger than 10 MB won’t be extracted.
  • Permissions are not synced by default. You must first enable DLS. Otherwise, all documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.

Document level securityedit

Document level security (DLS) enables you to restrict access to documents based on a user’s permissions. This feature is available by default for the OneDrive connector. See Configuration for how to enable DLS for this connector.

Refer to document level security for more details about this feature.

Refer to DLS in Search Applications to learn how to ingest data with DLS enabled, when building a search application.

Sync rulesedit

Basic sync rules are identical for all connectors and are available by default. For more information read Types of sync rule.

Advanced sync rulesedit

This connector supports advanced sync rules for remote filtering. These rules cover complex query-and-filter scenarios that cannot be expressed with basic sync rules. Advanced sync rules are defined through a source-specific DSL JSON snippet.

A full sync is required for advanced sync rules to take effect.

Here are a few examples of advanced sync rules for this connector.

Example 1edit

This rule skips indexing for files with .xlsx and .docx extensions. All other files and folders will be indexed.

[
  {
    "skipFilesWithExtensions": [".xlsx" , ".docx"]
  }
]
Example 2edit

This rule focuses on indexing files and folders owned by user1-domain@onmicrosoft.com and user2-domain@onmicrosoft.com but excludes files with .py extension.

[
  {
    "owners": ["user1-domain@onmicrosoft.com", "user2-domain@onmicrosoft.com"],
    "skipFilesWithExtensions": [".py"]
  }
]
Example 3edit

This rule indexes only the files and folders directly inside the root folder, excluding any .md files.

[
  {
    "skipFilesWithExtensions": [".md"],
    "parentPathPattern": "/drive/root:"
  }
]
Example 4edit

This rule indexes files and folders owned by user1-domain@onmicrosoft.com and user3-domain@onmicrosoft.com that are directly inside the abc folder, which is a subfolder of any folder under the hello directory in the root. Files with extensions .pdf and .py are excluded.

[
  {
    "owners": ["user1-domain@onmicrosoft.com", "user3-domain@onmicrosoft.com"],
    "skipFilesWithExtensions": [".pdf", ".py"],
    "parentPathPattern": "/drive/root:/hello/**/abc"
  }
]
Example 5edit

This example contains two rules. The first rule indexes all files and folders owned by user1-domain@onmicrosoft.com and user2-domain@onmicrosoft.com. The second rule indexes files for all other users, but skips files with a .py extension.

[
  {
    "owners": ["user1-domain@onmicrosoft.com", "user2-domain@onmicrosoft.com"]
  },
  {
    "skipFilesWithExtensions": [".py"]
  }
]
Example 6edit

This example contains two rules. The first rule indexes all files owned by user1-domain@onmicrosoft.com and user2-domain@onmicrosoft.com, excluding .md files. The second rule indexes files and folders recursively inside the abc folder.

[
  {
    "owners": ["user1-domain@onmicrosoft.com", "user2-domain@onmicrosoft.com"],
    "skipFilesWithExtensions": [".md"]
  },
  {
    "parentPathPattern": "/drive/root:/abc/**"
  }
]

Content Extractionedit

See Content extraction.

Connector client operationsedit

End-to-end testingedit

The 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 GitHub connector, run the following command:

$ make ftest NAME=onedrive

For faster tests, add the DATA_SIZE=small flag:

make ftest NAME=onedrive DATA_SIZE=small

Known issuesedit

  • Enabling document-level security impacts performance.

    Enabling DLS for your connector will cause a significant performance degradation, as the API calls to the data source required for this functionality are rate limited. This impacts the speed at which your content can be retrieved.

Refer to Known issues for a list of known issues for all connectors.

Troubleshootingedit

See Troubleshooting.

Securityedit

See Security.