IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Elastic GitHub connector reference Google Cloud Storage Connector »

› ›

Elastic Gmail connector reference

edit

Elastic Gmail connector reference

edit

The Elastic GMail connector is a connector for GMail.

Native connector reference (managed service)

edit

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

Availability and prerequisites

edit

This connector is available as a native connector (managed service) in Elastic Cloud.

This connector is compatible with Elastic versions 8.13.0+.

To use this connector, satisfy all native connector requirements.

Create a Gmail connector

edit

Use the UI

edit

To create a new Gmail connector:

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

For additional operations, see Using connectors.

Use the API

edit

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

For example:

PUT _connector/<my-gmail-connector>
{
  "index_name": "<my-elasticsearch-index>",
  "name": "Content synced from Gmail",
  "service_type": "gmail",
  "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:

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
        }
      ]
    }
  }
}

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>
}
```

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 as a native connector in Elastic Cloud, use the Connectors workflow in the Kibana UI.

To create a new Gmail connector:

Navigate to Search → Connectors page in the Kibana UI.
Select the New Native Connector button.
Select the Gmail connector.

For additional operations, see Using connectors.

Connector authentication prerequisites

edit

Before syncing any data from GMail, you need to create a service account with appropriate access to the GMail and the Google Directory API, which is part of the Google Admin SDK API. You also need to enable domain-wide delegation to impersonate the users you’re fetching messages from.

To get started, log into Google Cloud Platform and go to the Console.

Create a Google Cloud Project. Give your project a name, change the project ID and click the Create button.
Enable Google APIs. Choose APIs & Services from the left menu and click on Enable APIs and Services. You need to enable GMail API and the Google Admin SDK API.
Create a Service Account. In the APIs & Services section, click on Credentials and click on Create credentials to create a service account. Give your service account a name and a service account ID. This is like an email address and will be used to identify your service account in the future. Click Done to finish creating the service account.

Your service account needs to have access to at least the following scope:
- https://www.googleapis.com/auth/gmail.readonly
Create a Key File.
- In the Cloud Console, go to IAM and Admin > Service accounts page.
- Click the email address of the service account that you want to create a key for.
- Click the Keys tab. Click the Add key drop-down menu, then select Create new key.
- Select JSON as the Key type and then click Create. This will download a JSON file that will contain the service account credentials.
Google Workspace domain-wide delegation of authority.

To access user data like messages on a Google Workspace domain, the service account that you created needs to be granted access by a super administrator for the domain. You can follow the official documentation to perform Google Workspace domain-wide delegation of authority.

You need to grant the following OAuth Scopes to your service account:
- https://www.googleapis.com/auth/admin.directory.user.readonly
This step allows the connector to access user data and their group memberships in your Google Workspace organization.

Configuration

edit

The following configuration fields are required:

GMail service account JSON

The service account credentials generated from Google Cloud Platform (JSON string). Refer to the Google Cloud documentation for more information.

Google Workspace admin email

Google Workspace admin email. Required to enable document level security (DLS). A service account with delegated authority can impersonate an admin user with permissions to access Google Workspace user data and their group memberships. Refer to the Google Cloud documentation for more information.

Google customer ID

Google customer id. Required to fetch messages and to enable document level security (DLS). Go to Google Workspace Admin Console → Account and copy the value under Customer Id.

Include spam and trash emails

Toggle to fetch spam and trash emails. Also works with document level security (DLS).

Enable document level security

Toggle to enable DLS. DLS is supported for the GMail connector. 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.

Documents and syncs

edit

The connector will fetch all messages of all users the service account has access to.

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 are available for this connector. The connector supports the GMail advanced search syntax under the messages field.

For example:

{
  "messages": [
    "before:2021/10/10",
    "from:amy"
  ]
}

Document level security

edit

Document level security (DLS) enables you to restrict access to documents based on a user’s permissions. 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 a connector with DLS enabled, when building a search application. The example uses SharePoint Online as the data source, but the same steps apply to every connector.

Known issues

edit

There are currently no known issues for this connector.

This connector is built in Python with the Elastic connector framework.

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

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 from the Elastic connector framework.

This connector client is compatible with Elastic versions 8.10.0+.

To use this connector, satisfy all connector client requirements.

Create a Gmail connector

edit

Use the UI

edit

To create a new Gmail connector:

Navigate to the Search → Connectors page in the Kibana UI.
Follow the instructions to create a new Gmail 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 Gmail connector client.

For example:

PUT _connector/my-gmail-connector
{
  "index_name": "my-elasticsearch-index",
  "name": "Content synced from Gmail",
  "service_type": "gmail"
}

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:

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
        }
      ]
    }
  }
}

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 as a connector client, use the Connector workflow in the Kibana UI.

For additional operations, see Using connectors.

Connector authentication prerequisites

edit

To get started, log into Google Cloud Platform and go to the Console.

Create a Google Cloud Project. Give your project a name, change the project ID and click the Create button.
Enable Google APIs. Choose APIs & Services from the left menu and click on Enable APIs and Services. You need to enable GMail API and the Google Admin SDK API.
Create a Service Account. In the APIs & Services section, click on Credentials and click on Create credentials to create a service account. Give your service account a name and a service account ID. This is like an email address and will be used to identify your service account in the future. Click Done to finish creating the service account.

Your service account needs to have access to at least the following scope:
- https://www.googleapis.com/auth/gmail.readonly
Create a Key File.
- In the Cloud Console, go to IAM and Admin > Service accounts page.
- Click the email address of the service account that you want to create a key for.
- Click the Keys tab. Click the Add key drop-down menu, then select Create new key.
- Select JSON as the Key type and then click Create. This will download a JSON file that will contain the service account credentials.
Google Workspace domain-wide delegation of authority.

To access user data like messages on a Google Workspace domain, the service account that you created needs to be granted access by a super administrator for the domain. You can follow the official documentation to perform Google Workspace domain-wide delegation of authority.

You need to grant the following OAuth Scopes to your service account:
- https://www.googleapis.com/auth/admin.directory.user.readonly
This step allows the connector to access user data and their group memberships in your Google Workspace organization.

Configuration

edit

When using the connector client 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.

The following configuration fields are required:

GMail service account JSON

The service account credentials generated from Google Cloud Platform (JSON string). Refer to the Google Cloud documentation for more information.

Google Workspace admin email

Google customer id

Google customer id. Required to fetch messages and to enable document level security (DLS). Go to Google Workspace Admin Console → Account and copy the value under Customer Id.

Include spam and trash emails

Toggle to fetch spam and trash emails. Also works with DLS.

Enable document level security

Toggle to enable DLS. DLS is supported for the GMail connector. 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.

Deployment using Docker

edit

You can deploy the Gmail 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: gmail
    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.5.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

edit

The connector will fetch all messages of all users the service account has access to.

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 are available for this connector. The connector supports the GMail advanced search syntax under the messages field.

For example:

{
  "messages": [
    "before:2021/10/10",
    "from:amy"
  ]
}

Document level security

edit

Document level security (DLS) enables you to restrict access to documents based on a user’s permissions. Refer to configuration on this page for how to enable DLS for this connector.

Known issues

edit

There are currently no known issues for this connector.

Troubleshooting

edit

See Troubleshooting.

Security

edit

See Security.

Framework and source

edit

This connector is built in Python with the Elastic connector framework.

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

« Elastic GitHub connector reference Google Cloud Storage Connector »