Mimecast Source

The Mimecast Source supports collecting SIEM, DLP, Audit, and Hold Message List data from the Mimecast API. It securely stores the required authentication, scheduling, and state tracking information.

Data collected

Polling Interval	Data
5 min	SIEM Logs
5 min	DLP Logs
5 min	Audit Events
5 min	Hold Message List

Setup

Vendor configuration

The user account associated with your Mimecast credentials needs to have basic administrator access. The integration must be configured with the Base URL, Application key, Secret key, and Access key.

• The base URL parameter changes depending on the your global region. Refer to the Mimecast documentation for guidance as to which base URL should be used.

• To create the Application key, Secret key, and Access key, refer to the Mimecast documentation.

note

Enhanced logging needs to be enabled on the Mimecast side in order for the expected logs to be created and sent to Sumo Logic via the above channels. See Understanding SIEM Logs in the Mimecast documentation.

Source configuration

When you create a Mimecast Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.

To configure a Mimecast Source:

1. Classic UI. In the main Sumo Logic menu, select Manage Data > Collection > Collection.
   New UI. In the Sumo Logic top menu select Configuration, and then under Data Collection select Collection. You can also click the Go To... menu at the top of the screen and select Collection.
2. On the Collectors page, click Add Source next to a Hosted Collector.
3. Search for and select Mimecast.
4. Enter a Name for the Source. The description is optional.
5. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
6. Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM.
   
   note

   Select Forward to SIEM only if you have Cloud SIEM installed.

7. (Optional) Fields. Click the +Add Field link to define the fields you want to associate, each field needs a name (key) and value.
   •  A green circle with a check mark is shown when the field exists in the Fields table schema.
   •  An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
8. Base URL. Enter the Base URL.
9. Application Key. Enter the Application Key.
10. Application ID. Enter the Application ID.
11. Access Key. Enter the Access Key.
12. Secret Key. Enter the Secret Key.
13. Supported API to collect. Select the type of Mimecast data source that you want to collect.
14. Processing Rules for Logs (Optional). Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in Create a Processing Rule.
15. When you are finished configuring the Source, click Save.

Metadata fields

Field	Value	Description
_siemVendor	Mimecast	Set when Forward To SIEM is checked.
_siemProduct	Mimecast	Set when Forward To SIEM is checked.
_siemFormat	JSON	Set when Forward To SIEM is checked.
_siemEventID	receipt, process, delivery, jrnl, dlp, or ttp	The SIEM event ID is populated by the suffix of the file name, which references the log type.

JSON schema

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details. 

Parameter	Type	Value	Required	Description
schemaRef	JSON Object	{"type":"Mimecast"}	Yes	Define the specific schema type.
sourceType	String	"Universal"	Yes	Type of source.
config	JSON Object	Configuration object	Yes	Source type specific values.

Configuration Object

Parameter	Type	Required	Default	Description	Example
name	String	Yes	null	Type a desired name of the source. The name must be unique per Collector. This value is assigned to the metadata field _source.	"mySource"
description	String	No	null	Type a description of the source.	"Testing source"
category	String	No	null	Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details.	"mySource/test"
fields	JSON Object	No	null	JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.	{"_siemForward": false, "fieldA": "valueA"}
domain	String	Yes	null	Enter your customer specific Base URL.
application_key	String	Yes	null	Application Key for your Mimecast app.
application_id	String	Yes	null	Application ID for your Mimecast app.
access_key	String	Yes	null	Access Key for your Mimecast app.
secret_key	String	Yes	null	Secret Key for your Mimecast app.
dataCollection	String	Yes		Supported API.

JSON example

{
  "api.version": "v1",
  "source": {
    "config": {
      "name": "Mimecast",
      "description": "Mimecast",
      "category": "Mimecast",
      "domain": "us-api.mimecast.com",
      "application_key": "a32axxxx-xxxx-xxxx-xxxx-xxxxxxb189bd",
      "application_id": "e399xxxx-xxxx-xxxx-xxxx-xxxxxx71eead",
      "access_key": "uGAN9BAxxxxx-xxxxxxxl8Sp06XEdky6tY",
      "secret_key": "zjRtw77K+7rtFYWxxxxxxxxxxxjB+DINTfzA",
      "supported_apis": [
        "SIEM",
        "DLP",
        "Audit Events",
        "Hold Message List"
      ]
    },
    "schemaRef": {
      "type": "Mimecast"
    },
    "sourceType": "Universal"
  }
}

Download example

Terraform example

resource "sumologic_cloud_to_cloud_source" "mimecast-source" {
  collector_id = sumologic_collector.collector.id
  schema_ref = {
    type = "Mimecast"
  }
  config = jsonencode({
"name": "Mimecast",
      "description": "Mimecast",
      "category": "Mimecast",
      "domain": "us-api.mimecast.com",
      "application_key": "a32axxxx-xxxx-xxxx-xxxx-xxxxxxb189bd",
      "application_id": "e399xxxx-xxxx-xxxx-xxxx-xxxxxx71eead",
      "access_key": "uGAN9BAxxxxx-xxxxxxxl8Sp06XEdky6tY",
      "secret_key": "zjRtw77K+7rtFYWxxxxxxxxxxxjB+DINTfzA",
      "supported_apis": [
        "SIEM",
        "DLP",
        "Audit Events",
        "Hold Message List"
      ]
  })
}
resource "sumologic_collector" "collector" {
  name        = "my-collector"
  description = "Just testing this"
}

Download example

Troubleshooting

After configuring your source, you should check the status of the source in the Collectors page > Status column. If the source is not functioning as expected, you may see an error next to the Source Category column as shown below: 

Error Code: 401
Error Details:

{
    "error": "Client credentials are invalid"
}

To resolve these errors:

• Make sure correct Client ID or Secret Key is used to configure the source.

FAQ

info

Click here for more information about Cloud-to-Cloud sources.