This is a cache of https://www.elastic.co/guide/en/enterprise-search/current/connectors-zoom.html. It is a snapshot of the page at 2024-10-18T00:35:23.104+0000.
Elastic Zoom connector reference | Enterprise Search documentation [8.15] | Elastic
« Elastic Microsoft Teams connector reference Elastic web crawler »
Elastic Docs › ›Connectors references

Elastic Zoom connector reference

edit

Elastic Zoom connector reference

edit

The Zoom connector is written in Python using the Elastic connector framework.

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

Native connector reference (managed service)

edit
View reference for the native connector reference (managed service).

Availability and prerequisites

edit

This native connector was introduced in Elastic 8.14.0 as a managed service on Elastic Cloud.

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

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.

Create a Zoom connector

edit
Use the UI
edit

To create a new Zoom connector:

  1. Navigate to the Search → Connectors page in the Kibana UI.
  2. Follow the instructions to create a new native Zoom connector.

For additional operations, see Using connectors.

Use the API
edit

You can use the Elasticsearch Create connector API to create a new native Zoom connector.

For example:

PUT _connector/<my-zoom-connector>
{
  "index_name": "<my-elasticsearch-index>",
  "name": "Content synced from Zoom",
  "service_type": "zoom",
  "is_native": "true"
}
You’ll also need to create an API key for the connector to use.

The user needs the cluster privileges manage_api_key, manage_connector and write_connector_secrets to generate API keys programmatically.

To create an API key for the connector:

  1. Run the following command, replacing values where indicated. Note the id and encoded return values from the response:

    POST /_security/api_key
{
  "name": "<connector_name>-connector-api-key",
  "role_descriptors": {
    "<connector_name>-connector-role": {
      "cluster": [
        "monitor",
        "manage_connector"
      ],
      "indices": [
        {
          "names": [
            "<index_name>",
            ".search-acl-filter-<index_name>",
            ".elastic-connectors*"
          ],
          "privileges": [
            "all"
          ],
          "allow_restricted_indices": false
        }
      ]
    }
  }
}

  2. Use the encoded value to store a connector secret, and note the id return value from this response:

    POST _connector/_secret
{
  "value": <encoded_api_key>
}

  3. Use the API key id and the connector secret id to update the connector:

    PUT /_connector/<connector_id>/_api_key_id
{
  "api_key_id": "<API key id>",
  "api_key_secret_id": "<secret id>"
}

Refer to the Elasticsearch API documentation for details of all available Connector APIs.

Usage

edit

To use this connector in the UI, select the Zoom tile when creating a new connector under Search → Connectors.

If you’re already familiar with how connectors work, you can also use the Connector APIs.

For additional operations, see Using connectors.

Connecting to Zoom

edit

To connect to Zoom you need to create an Server-to-Server OAuth application that can access resources. Follow these steps:

  1. Go to the Zoom App Marketplace and sign in with your Zoom account.
  2. Navigate to the "Develop" service.
  3. Select "Build App" from the dropdown menu.
  4. Click on the "Server-to-Server OAuth" button to register a new application.
  5. Provide a name for your app.
  6. Click on the "Create" 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 "App Credentials" value, as you’ll need it later.
  8. Navigate to the "Scopes" section and click on the "Add Scopes" button.

  9. The following granular scopes need to be added to the app.

    user:read:list_users:admin
meeting:read:list_meetings:admin
meeting:read:list_past_participants:admin
cloud_recording:read:list_user_recordings:admin
team_chat:read:list_user_channels:admin
team_chat:read:list_user_messages:admin

The connector requires a minimum scope of user:read:list_users:admin to ingest data into Elasticsearch.

+ 10. Click on the "Done" button to add the selected scopes to your app. 11. Navigate to the "Activation" section and input the necessary information to activate the app.

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

Configuration

edit

The following configuration fields are required:

Zoom application Account ID

(required) "Account ID" is a unique identifier associated with a specific Zoom account within the Zoom platform, found on the app’s overview page. Example:

  • KVx-aQssTOutOAGrDfgMaA
Zoom application Client ID

(required) "Client ID" refers to a unique identifier associated with an application that integrates with the Zoom platform, found on the app’s overview page. Example:

  • 49Z69_rnRiaF4JYyfHusw
Zoom application Client Secret

(required) The "Client Secret" refers to a confidential piece of information generated when developers register an application on the Zoom Developer Portal for integration with the Zoom platform, found on the app’s overview page. Example:

  • eieiUJRsiH543P5NbYadavczjkqgdRTw
Recording Age Limit (Months)
(required) How far back in time to request recordings from Zoom. Recordings older than this will not be indexed. This configuration parameter allows you to define a time limit, measured in months, for which recordings will be indexed.
Fetch past meeting details
Retrieve more information about previous meetings, including their details and participants. Default value is False. Enable this option to fetch past meeting details. This setting can increase sync time.
Content Extraction
edit

Refer to content extraction in the official docs.

Documents and syncs

edit

The connector syncs the following objects and entities:

  • Users
  • Live Meetings
  • Upcoming Meetings
  • Past Meetings
  • Recordings
  • Channels
  • Chat Messages
  • Chat Files
  • 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. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.
Sync types
edit

Full syncs are supported by default for all connectors.

This connector also supports incremental syncs.

Sync rules

edit

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

Advanced Sync Rules

edit

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

Known issues

edit
  • Meetings: Users can only index meetings that are less than a month old.
  • Chat Messages & Files:Users can only index chats and files that are less than 6 months old.

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

Troubleshooting

edit

See Troubleshooting.

Security

edit

See Security.

Connector client reference (self-managed)

edit
View reference for the connector client reference (self-managed).

Availability and prerequisites

edit

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.

Create a Zoom connector

edit
Use the UI
edit

To create a new Zoom connector:

  1. Navigate to the Search → Connectors page in the Kibana UI.
  2. Follow the instructions to create a new Zoom connector client.

For additional operations, see Using connectors.

Use the API
edit

You can use the Elasticsearch Create connector API to create a new self-managed Zoom connector client.

For example:

PUT _connector/my-zoom-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Zoom",
  "service_type": "zoom"
}
You’ll also need to create an API key for the connector to use.

The user needs the cluster privileges manage_api_key, manage_connector and write_connector_secrets to generate API keys programmatically.

To create an API key for the connector:

  1. Run the following command, replacing values where indicated. Note the encoded return values from the response:

    POST /_security/api_key
{
  "name": "<connector_name>-connector-api-key",
  "role_descriptors": {
    "<connector_name>-connector-role": {
      "cluster": [
        "monitor",
        "manage_connector"
      ],
      "indices": [
        {
          "names": [
            "<index_name>",
            ".search-acl-filter-<index_name>",
            ".elastic-connectors*"
          ],
          "privileges": [
            "all"
          ],
          "allow_restricted_indices": false
        }
      ]
    }
  }
}
  2. Update your config.yml file with the API key encoded value.

Refer to the Elasticsearch API documentation for details of all available Connector APIs.

Usage

edit

To use this connector in the UI, select the Teams tile when creating a new connector under Search → Connectors.

If you’re already familiar with how connectors work, you can also use the Connector APIs.

For additional operations, see Using connectors.

Connecting to Zoom

edit

To connect to Zoom you need to create an Server-to-Server OAuth application that can access resources. Follow these steps:

  1. Go to the Zoom App Marketplace and sign in with your Zoom account.
  2. Navigate to the "Develop" service.
  3. Select "Build App" from the dropdown menu.
  4. Click on the "Server-to-Server OAuth" button to register a new application.
  5. Provide a name for your app.
  6. Click on the "Create" 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 "App Credentials" value, as you’ll need it later.
  8. Navigate to the "Scopes" section and click on the "Add Scopes" button.

  9. The following granular scopes need to be added to the app.

    user:read:list_users:admin
meeting:read:list_meetings:admin
meeting:read:list_past_participants:admin
cloud_recording:read:list_user_recordings:admin
team_chat:read:list_user_channels:admin
team_chat:read:list_user_messages:admin

The connector requires a minimum scope of user:read:list_users:admin to ingest data into Elasticsearch.

+ 10. Click on the "Done" button to add the selected scopes to your app. 11. Navigate to the "Activation" section and input the necessary information to activate the app.

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

Configuration

edit

The following configuration fields are required:

Zoom application Account ID

(required) "Account ID" is a unique identifier associated with a specific Zoom account within the Zoom platform, found on the app’s overview page. Example:

  • KVx-aQssTOutOAGrDfgMaA
Zoom application Client ID

(required) "Client ID" refers to a unique identifier associated with an application that integrates with the Zoom platform, found on the app’s overview page. Example:

  • 49Z69_rnRiaF4JYyfHusw
Zoom application Client Secret

(required) The "Client Secret" refers to a confidential piece of information generated when developers register an application on the Zoom Developer Portal for integration with the Zoom platform, found on the app’s overview page. Example:

  • eieiUJRsiH543P5NbYadavczjkqgdRTw
Recording Age Limit (Months)
(required) How far back in time to request recordings from Zoom. Recordings older than this will not be indexed. This configuration parameter allows you to define a time limit, measured in months, for which recordings will be indexed.
Fetch past meeting details
Retrieve more information about previous meetings, including their details and participants. Default value is False. Enable this option to fetch past meeting details. This setting can increase sync time.
Deployment using Docker
edit

You can deploy the Zoom 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.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: zoom
    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.15.3.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.

Content Extraction
edit

Refer to content extraction in the official docs.

Documents and syncs

edit

The connector syncs the following objects and entities:

  • Users
  • Live Meetings
  • Upcoming Meetings
  • Past Meetings
  • Recordings
  • Channels
  • Chat Messages
  • Chat Files
  • Content from files bigger than 10 MB won’t be extracted by default. You can use the self-managed local extraction service to handle larger binary files.
  • Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.
Sync types
edit

Full syncs are supported by default for all connectors.

This connector also supports incremental syncs.

Sync rules

edit

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

Advanced Sync Rules

edit

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

Connector Client operations

edit
End-to-end Testing
edit

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

$ make ftest NAME=zoom

For faster tests, add the DATA_SIZE=small flag:

make ftest NAME=zoom DATA_SIZE=small

Known issues

edit
  • Meetings: Users can only index meetings that are less than a month old.
  • Chat Messages & Files:Users can only index chats and files that are less than 6 months old.

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

Troubleshooting

edit

See Troubleshooting.

Security

edit

See Security.

« Elastic Microsoft Teams connector reference Elastic web crawler »