Send Mimecast logs to LogPulse

Mimecast Targeted Threat Protection logs (URL clicks, attachments, impersonation) and the Mimecast audit log through API 2.0.

In short
To send Mimecast logs to LogPulse, add Mimecast under Configure → Sources → Cloud. LogPulse reads the Mimecast API 2.0 itself, without an agent. Events land in the email, audit indexes with source mimecast and fill the Email, Change data models.

Overview

How Mimecast data reaches LogPulse
Vendor
Mimecast API 2.0
Collect
Integration pollerreads new events, maps the fields
Store
index=email
index=audit
  1. Mimecast API 2.0 to Integration poller
  2. Integration poller to index=email
  3. Integration poller to index=audit

LogPulse signs in to Mimecast with the credential you give it and fetches new events every five minutes by default. You can set the interval per integration, from one minute to 24 hours.

What you need

  • A Mimecast API 2.0 application with Audit and Threat Protection
  • In LogPulse: a role that may manage API keys. Cloud integrations fall under that right.

1. Create a credential in Mimecast

Field in LogPulseWhere you find it
Client IDIn Mimecast: Administration, Services, API and Platform Integrations, Your Application Integrations. Add an API 2.0 application with the products Audit and Threat Protection.
Client secretStored encrypted and never shown again.

2. Add the integration in LogPulse

Go to Configure → Sources → Cloud and choose Mimecast. Fill in the fields, tick the data sources you want and save. LogPulse first tests the connection with your credential and tells you what is wrong when it fails.

Tip: Secrets are stored encrypted and never shown again. To change one, paste a new value; the rest stays.

What arrives

Data sourceIndexSourceSourcetypeWhat it holds
URL ProtectemailmimecastmimecastttpurlstClicks on rewritten links: user, URL, verdict and whether the click was allowed.
Attachment ProtectemailmimecastmimecastttpapstAttachments that were sandboxed: sender, recipient, file, hashes and verdict.
Impersonation ProtectemailmimecastmimecastttpipstMessages that looked like impersonation: sender, recipient, what matched and the action.
Audit logauditmimecastmimecastauditstAdmin and user actions in Mimecast: who, which change and when.

The index is the kind of data and the source is the product, so detection rules for that kind of data find Mimecast without changes.

Note: LogPulse reads the logs two minutes behind real time.

Fields and data models

Data modelWhat you get
EmailClicks, attachments and impersonation with sender, recipient and verdict.
ChangeAudit entries with user and change.

Field names follow the CIM field names. These are the fields LogPulse sets on Mimecast events; a field is left out when Mimecast did not send a value.

  • action
  • category
  • count
  • description
  • file_hash
  • file_name
  • file_type
  • id
  • identifiers
  • message_id
  • object_category
  • recipient
  • route
  • signature
  • src_ip
  • src_user
  • subject
  • threat_suspected
  • url
  • user
  • user_awareness_action
  • vendor_action
  • verdict

The original record of Mimecast is kept with each event under raw, so nothing the vendor sent is lost.

3. Check the data

The first events arrive within a few minutes. Check what came in:

earliest=-1h index IN (email, audit) source IN (mimecast)
| stats count by index, source, sourcetype

The integration page in LogPulse shows when it last read events and the last error, if any.

Troubleshooting

The connection test names what is wrong. These are the answers you are most likely to see.

What you seeWhat to do
Mimecast refused the client id and secret.Create a new API 2.0 application under Administration, Services, API and Platform Integrations. Keys of the older API 1.0 do not work.
The API application cannot read the audit log. Give it the Audit and TTP products in the API application settings.Edit the API application and add the products Audit and Threat Protection.
The test passes but no events arrive.Run the search above over a longer time. No results: check on the integration page that the data source is switched on and when it last read events. Mimecast may also simply have had nothing new.

Frequently asked questions

How do I send Mimecast logs to LogPulse?
Add the Mimecast cloud integration under Configure, Sources, Cloud in LogPulse and fill in Client ID, Client secret. LogPulse reads the Mimecast API 2.0 itself, every five minutes by default; there is nothing to install.
Which permissions does LogPulse need in Mimecast?
A Mimecast API 2.0 application with Audit and Threat Protection. Read access is enough for collecting logs.
Which index does Mimecast data go to?
The index is the kind of data: email, audit. The source is the product: mimecast. Each data source has its own sourcetype, listed on this page.
Which data models does Mimecast fill?
Email, Change. Detection rules and dashboards written for a data model work on Mimecast without changes.