Elastic Microsoft Teams connector referenceedit

This connector is built with the Elastic connector framework and is available as a self-managed connector client.

Availability and prerequisitesedit

This connector is available as a self-managed connector client. To use this connector, satisfy all connector client prerequisites.

This connector is in technical preview 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. Technical preview features are not subject to the support SLA of official GA features.

Usageedit

To use this connector as a connector client, use the Microsoft Teams tile from the connectors list Customized connector workflow.

For additional operations, see Using connectors.

Connecting to Microsoft Teamsedit

To connect to Microsoft Teams 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. Select the following permissions:

    • TeamMember.Read.All (Delegated)
    • Team.ReadBasic.All (Delegated)
    • TeamsTab.Read.All (Delegated)
    • Group.Read.All (Delegated)
    • ChannelMessage.Read.All (Delegated)
    • Chat.Read (Delegated) & Chat.Read.All (Application)
    • Chat.ReadBasic (Delegated) & Chat.ReadBasic.All (Application)
    • Files.Read.All (Delegated and Application)
    • Calendars.Read (Delegated and Application)
  11. Click on the Add permissions button to add the selected permissions to your app.
  12. Click on the Grant admin consent button to grant the required permissions to the app. This step requires administrative privileges. If you are not an admin, you need to request the admin to grant consent via their Azure Portal.
  13. Under the "Certificates & Secrets" tab, go to Client Secrets. Generate a new client secret and keep a note of the string under the Value column.

After completion, use the following configuration parameters to configure the connector.

Configurationedit

The following configuration fields are required:

client_id (required)

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

  • ab123453-12a2-100a-1123-93fd09d67394
secret_value (required)

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 (required)

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

  • 123a1b23-12a3-45b6-7c8d-fc931cfb448d
username (required)

Username for your Azure Application. Example:

  • dummy@3hmr2@onmicrosoft.com
password (required)

Password for your Azure Application. Example:

  • changeme

Deployment using Dockeredit

You can deploy the Microsoft Teams 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: microsoft_teams
    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.

Content Extractionedit

Refer to Content extraction.

Documents and syncsedit

The connector syncs the following objects and entities:

  • USER_CHATS_MESSAGE
  • USER_CHAT_TABS
  • USER_CHAT_ATTACHMENT
  • USER_CHAT_MEETING_RECORDING
  • USER_MEETING
  • TEAMS
  • TEAM_CHANNEL
  • CHANNEL_TAB
  • CHANNEL_MESSAGE
  • CHANNEL_MEETING
  • CHANNEL_ATTACHMENT
  • CALENDAR_EVENTS
  • Files bigger than 10 MB won’t be extracted.
  • Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.

Sync rulesedit

Basic sync rules are identical for all connectors and are available by default.

Advanced Sync Rulesedit

Advanced sync rules are not available for this connector in the present version.

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

$ make ftest NAME=microsoft_teams

For faster tests, add the DATA_SIZE=small flag:

make ftest NAME=microsoft_teams DATA_SIZE=small

Known issuesedit

  • Messages in one-on-one chats for Chat with Self users are not fetched via Graph APIs. Therefore, these messages won’t be indexed into Elasticsearch.

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

Troubleshootingedit

See Troubleshooting.

Securityedit

See Security.

Framework and sourceedit

This connector is included in the Elastic connector framework.

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