> For the complete documentation index, see [llms.txt](https://docs.dropzone.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dropzone.ai/integrations/alert/mimecast.md).

# Mimecast

Dropzone AI integrates with [Mimecast 2.0](https://www.mimecast.com/), a secure email gateway that sits in front of an organization's email and filters emails, detecting threats such as malware, phishing and scams.

## Integration Overview

To enable these integrations you will perform the following actions:

* Create a Custom Administration Role for your application
* Create an API 2.0 application
* Select integration parameters, such as which alert types to sync

## Create a Custom Admin Role

To limit Dropzone's access to your data, you may choose to create a custom [administrator role](https://mimecastsupport.zendesk.com/hc/en-us/articles/34000745394963-Roles-Understanding-Administrator-Roles#h_01JA88CBVKZ961KRA66F67D34Q) for your API application. You may skip this step and use the `Super Administrator` role instead.

* In your Mimecast homepage, click "Administration Console"

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FqmyvTwonGTFA70FIh0dR%2Fmimecast-1.png?alt=media" alt=""><figcaption><p>Click Administration Console</p></figcaption></figure>

* In the left hand sidebar, navigate to Account > Admin Roles

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FAGws0uMUgAmQYICxcgO6%2Fmimecast-2.png?alt=media" alt=""><figcaption><p>Click "Admin Roles"</p></figcaption></figure>

* Click "New Role"

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FfWVneGZMJ7GzNksY6npi%2Fmimecast-3.png?alt=media" alt=""><figcaption></figcaption></figure>

* Name the role something memorable, such as "Dropzone AI Application Role"

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FHSrwH3SsU2wZr8i44Ftq%2Fmimecast-4.png?alt=media" alt=""><figcaption></figcaption></figure>

* Assign the role the following permissions:

| Permission                                                          | Scope        | Purpose                                                            |
| ------------------------------------------------------------------- | ------------ | ------------------------------------------------------------------ |
| Security Events and Data Retrieval - Threat and Security Statistics | Read         | Allows Dropzone to see flagged threats and alerts within Mimecast  |
| Gateway - Tracking                                                  | Read         | Allows Dropzone to search for and retrieve specific email messages |
| Archive - Search                                                    | Read         | Allows Dropzone to retrieve email body content                     |
| Archive - Search                                                    | Content View | Allows Dropzone to retrieve email body content                     |

{% hint style="info" %}
You may only create a role with the Archive - Search `Content View` permission if you have Superadmin privileges. Contact your Mimecast representative if you do not have it.
{% endhint %}

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FrCNcerFGhlrNixxFSFJC%2Fmimecast-5.png?alt=media" alt=""><figcaption><p>The "Security Events and Data Retrieval" permission section</p></figcaption></figure>

* At the top of the role, click "Save and Exit"

## Create an API Key

Mimecast requires an API key to enable. To create an API key, you must have a Security Permissions setting of "Manage Application Roles"

* In your Mimecast homepage, click "Administration Console"

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FqmyvTwonGTFA70FIh0dR%2Fmimecast-1.png?alt=media" alt=""><figcaption><p>Click Administration Console</p></figcaption></figure>

* In the left hand sidebar, navigate to Integrations > API and Platform Integrations

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2F1CwOmLHlDKn0XpFmha9b%2Fmimecast-6.png?alt=media" alt=""><figcaption><p>Click "API and Platform Integrations"</p></figcaption></figure>

* Locate the Mimecast API 2.0 tile
* Click "Generate Keys"

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FmbIYR8mGuhxQf4Ny4uo2%2Fmimecast-7.png?alt=media" alt=""><figcaption><p>Click "Generate Keys"</p></figcaption></figure>

* Name the application something memorable, such as Dropzone AI
* Select the products you want Dropzone to have access to
* Assign the application a role (either the custom role you just created or the Full Administrator role)
* Input a memorable description for the application

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FwgtVkVwwOSvBkr5XFSQ2%2Fmimecast-8.png?alt=media" alt=""><figcaption><p>Input the application details</p></figcaption></figure>

* Designate a Technical Point of Contact for the application

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2Ftj7LCpp7Ai3ichqTKIUl%2Fmimecast-9.png?alt=media" alt=""><figcaption><p>Input the Notification Settings</p></figcaption></figure>

* At the top of the application, click "Save"
* Copy the credentials shown for use later in the Dropzone UI where they are called "Client ID" and "Client Secret" respectively

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FOQ2dOMqAOxrJATqAm79V%2Fmimecast-10.png?alt=media" alt=""><figcaption><p>Save the API Credentials</p></figcaption></figure>

## Enable Mimecast

To enable the Alert Source integration, you will need the following information:

| Dropzone Field | Source                                                                                                                                                                                                                          |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API URL        | The URL of your Mimecast 2.0 instance. If you do not know your API URL, see [here](https://developer.services.mimecast.com/api-overview#:~:text=with%20appropriate%20permissions.-,API,-Gateway%20Options) for more information |
| Client ID      | The Client ID value you generated earlier                                                                                                                                                                                       |
| Client Secret  | The Client Secret value you generated earlier                                                                                                                                                                                   |

To enable the Alert Source integration, do the following:

* Navigate to your Dropzone AI tenant home page e.g. https\://*mycompany*.dropzone.app
* In the left side bar, navigate to Platform Settings > Integrations

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FQKQGU2YK0KqsewZWvh0i%2Fui-integrations-dropdown.png?alt=media" alt=""><figcaption><p>Integrations Dropdown</p></figcaption></figure>

* Click "Library"

{% hint style="info" %}
If you have previously integrated this application, click "Configured"
{% endhint %}

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2Fx4O3FuRG5IqPwx5sFuHr%2Fapp_system_integrations_library.png?alt=media" alt=""><figcaption><p>Click Library</p></figcaption></figure>

* In the Search bar, search Mimecast, then click "Configure"

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2F6v0ygMV5WBwwek95s4eO%2Fapp_system_integrations_available_mimecast.png?alt=media" alt=""><figcaption><p>The Mimecast Tile</p></figcaption></figure>

* Input the API URL, Client ID and Client Secret

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FKzO1GL5YHxhFi0xHnrtD%2Fapp_system_integrations_available_mimecast_alert_config_1.png?alt=media" alt=""><figcaption><p>The Mimecast Alert Source Configuration (pt 1)</p></figcaption></figure>

* Select the [types](https://mimecastsupport.zendesk.com/hc/en-us/articles/34000509365651-Analysis-Response#h_01JED5RV0B0N5GXENM8PRVM6NG:~:text=Protection%20blocked%20clicks.-,Detection,-Categories) of threats you want Dropzone to investigate

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FJNW50xjLyrPGFhUg540D%2Fapp_system_integrations_available_mimecast_alert_config_2.png?alt=media" alt=""><figcaption><p>The Mimecast Alert Source Configuration (pt 2)</p></figcaption></figure>

* Select the [statuses](https://mimecastsupport.zendesk.com/hc/en-us/sections/34523591340051-Message-Center) of threats you want Dropzone to investigate

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FnOW2OiWqDtFxD6mCZP91%2Fapp_system_integrations_available_mimecast_alert_config_3.png?alt=media" alt=""><figcaption><p>The Mimecast Alert Source Configuration (pt 3)</p></figcaption></figure>

* Select the threat sources you want Dropzone AI to ingest

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2F0AxhZYhrjmh5pZrfHuoz%2Fapp_system_integrations_available_mimecast_alert_config_4.png?alt=media" alt=""><figcaption><p>The Mimecast Alert Source Configuration (pt 4)</p></figcaption></figure>

* Check the box labeled "Search Content View Enabled" to allow Dropzone to retrieve the content of emails for analysis

{% hint style="success" %}
Only do so if you have granted the application the necessary permissions.
{% endhint %}

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FjssO55iT0e9BG0j2JYKn%2Fapp_system_integrations_available_mimecast_alert_config_5.png?alt=media" alt=""><figcaption><p>The Mimecast Alert Source Configuration (pt 5)</p></figcaption></figure>

* Input your desired poll interval and lookback

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FHVBJ98XYaCSKhc4Ujvy0%2Fpoll-interval-lookback.png?alt=media" alt=""><figcaption><p>The Mimecast Alert Source Configuration (pt 5)</p></figcaption></figure>

* If you wish to further filter alerts using the Python [CEL](https://python-common-expression-language.readthedocs.io/en/stable/tutorials/cel-language-basics/) package, check the box labeled "Use advanced filtering"
* Input your CEL expression, then select whether to include or exclude alerts matching that filter. Add each filter individually using the "Add Item" button
* Contact our Customer Success team for more information about this feature

<figure><img src="https://3968177484-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FDt9gEGwbp9ApiQAJP3hQ%2Fuploads%2FI56AMieT91vHIswUkCuf%2Fadvanced-filtering-test-save.png?alt=media" alt=""><figcaption><p>The Mimecast Alert Source Configuration (pt 6)</p></figcaption></figure>

* Click "Test & Save" to finish

If you have any errors or questions, contact our Customer Success team.
