Mimecast API 2.0
Still using Mimecast API 1.0 event sources?
At Rapid7, we regularly assess and update our supported platforms to bring you the most secure and efficient solutions. As part of this ongoing process, we are discontinuing our Mimecast API 1.0 event source and introducing a new Mimecast API 2.0 event source. Here's what you should know:
- Mimecast have announced they will soon be deprecating their Mimecast API 1.0 and are introducing a new Mimecast API 2.0. Read more from Mimecast’s documentation: https://developer.services.mimecast.com/api-overview#when-should-i-use.
- We will continue to support existing Mimecast API 1.0 event sources you may have until April 15, 2025. After we deprecate this functionality, you must migrate your existing Mimecast API 1.0 event sources to the new Mimecast API 2.0 event source to continue collecting data.
- As of February 20, 2025, you will only be able to create new Mimecast API 2.0 event sources and will not be able to create any new Mimecast API 1.0 event sources.
- You can read more about migrating from Mimecast API 1.0 to Mimecast API 2.0 through the third party documentation.
Mimecast is a cloud-based email management system that detects threats hidden in your email. If you have Mimecast licensed, you can send specific types of events to InsightIDR, where they will generate Virus Infection and Web Proxy detections.
To set up the Mimecast API 2.0 event source, complete these steps:
- Read the requirements and complete the prerequisite steps.
- Configure Mimecast to send data to InsightIDR.
- Configure InsightIDR to receive data from the event source.
- Test the configuration.
Requirements
Before you start the configuration:
- Create a service account with the Administrator role and ensure that it is in the Basic Administrators group. View the third party instructions.
- Ensure that the Administrator service account has the following Application Permissions enabled:
- Gateway Menu > Tracking > Read
- Security Events and Data Retrieval > Threat
- Security Events (SIEM) > Read
- Ensure the Security Permissions setting for the Administrator service account permits the Management of Application Roles.
- Ensure enhanced logging for email is enabled. View the third party instructions.
Configure Mimecast to send data to InsightIDR
To allow InsightIDR to receive data from Mimecast, you must create an API 2.0 application and configure specific settings in your Mimecast account.
- Log in to the Mimecast Administration Console and create an API 2.0 Application. Note it may take several minutes for the application to be available. View the instructions through the third party documentation.
- Copy the Client ID and Client Secret and save these in a secure location for later.
Configure InsightIDR to recieve data from the event souce
After you create your API 2.0 application in Mimecast and obtain the necessary keys, you can set up your Mimecast event source in InsightIDR.
Task 1: Select Mimecast
- Go to Data Collection and click Setup Event Source > Add Event Source.
- Do one of the following:
- Search for Mimecast in the event sources search bar.
- In the Product Type filter, select Cloud Service.
- Select the Mimecast event source tile.
Task 2: Set up the Cloud Connection
New credentials are required for cloud event sources
You cannot reuse existing on-premise credentials to create a cloud connection with this event source. You must create new credentials.
- In the Add Event Source panel, select Run On Cloud.
- Name the event source. This will be the name of the log that contains the event data in Log Search. If you do not name the event source, the log name will default to Mimecast
- Optionally, select the option to send unparsed data.
- Select your Account Attribution preference:
- Use short name attribution: The system first attempts to attribute data by email address, for example,
jsmith@myorg.example.com
. If the first attempt is unsuccessful, attribution is attempted by short name, for example,jsmith
. If the short name is unsuccessful, attribution is attempted by a user’s first and last name, for example,John Smith
. - Use fully qualified domain name attribution: The system first attempts to attribute data by email address, for example,
jsmith@myorg.example.com
. If the first attempt is unsuccessful, attribution is attempted by a user’s first and last name, for example,John Smith
. This option is best if your environment has collisions with short names.
- Use short name attribution: The system first attempts to attribute data by email address, for example,
- Optionally, specify the Active Directory Domain for Multi-domain Environments.
- Select an attribution source.
- Click Add a New Connection.
- In the Create a Cloud Connection screen, enter a name for the new connection.
- In the Client ID field, enter your Mimecast Client ID you obtained previously.
- In the Client Secret field, add a new credential:
- Name your credential.
- Describe your credential.
- Select the credential type.
- Enter the Mimecast Client Secret you obtained previously.
- Specify the product access for this credential.
- Click Save Connection.
- Click Save.
Test the configuration
InsightIDR currently ingests Mimecast data sent via API and parses only these Mimecast event types:
- Receipt - These events show the actions taken on an email, including whether the email successfully made it to the recipient’s inbox or if the email was rejected due to an invalid address
- Targeted Threat Protection URL - These events are generated when there are malicious or phishing links in emails.
- Targeted Threat Protection Attachment - These events show the results of attachment scanning from Mimecast.
To test that event data is flowing into InsightIDR through the Cloud Connection:
- View the raw logs:
- From the Data Collection Management page, click the Event Sources tab.
- Find the event source you created and click View raw log. If the Raw Logs modal displays raw log entries, logs are successfully flowing to InsightIDR.
- Use Log Search to find the log entries. After approximately seven minutes, you can verify that log entries are appearing in Log Search.
- From the left menu, go to Log Search.
- In the Log Search filter, search for the new event source you created.
- Select the log sets and the log names under each log set. Mimecast logs flow into these log sets:
- Virus Infection
- Web Proxy
- Set the time range to Last 10 minutes and click Run.
The Results table displays all log entries that flowed into InsightIDR in the last 10 minutes. The keys and values that are displayed are helpful when you want to build a query and search your logs.