Configuring Mimecast API 2.0 Connectors

This connector allows Stellar Cyber to ingest Mimecast logs and add the records to the data lake. It integrates with Mimecast API 2.0 to query MTA logs.

This connector uses Mimecast API 2.0. For an API Overview, refer to https://developer.services.mimecast.com/api-overview.

Stellar Cyber connectors with the Collect function (collectors) may skip collecting some data when the ingestion volume is large, which potentially can lead to data loss. This can happen when the processing capacity of the collector is exceeded.

Connector Overview: Mimecast API 2.0

Adding a Mimecast Connector

To add a Mimecast connector:

1. Obtain credentials
2. Add the connector in Stellar Cyber
3. Test the connector
4. Verify ingestion

Obtaining Mimecast Credentials

To use this endpoint, the logged in user must be a Mimecast Administrator with at least the Security Events and Data Retrieval > Threat and Security Events (SIEM) > Read permission. (You can locate these permissions using the following path: Account > Admin Roles > View Role (for an administrator role) > Application Permissions).

Before you configure the connector in Stellar Cyber, you must obtain the following Mimecast credentials:

• Base URL—URL, for example, https://api.services.mimecast.com

• Client ID and Client Secret—Mimecast Client ID and Client Secret used to authenticate your account

The Mimecast API 2.0 connector uses OAuth2 and requires two parameters to authenticate: Client ID and Client Secret. The parameters are used to generate a short lived access token by sending a request to a specific endpoint.

The generated access token is attached on the header for each request. When the token is expired, a new token needs to be regenerated.

Generating Client ID and Client Secret

Follow the guidance in the Mimecast documentation.

The administrator must be assigned a role with the following criteria:

• Read and Edit API Application Permissions under the Service Menu.

• Security Permissions setting must permit the Management of Application Roles.

To generate the client ID and client secret:

1. Log in to the Mimecast Administration Console, click Services and select API and Platform Integrations.

   

2. Navigate to Your API 2.0 Applications and click Generate Keys.

   

3. Read the Terms and Conditions and select I accept and click Next.

   

4. Fill in Application Details or select from the drop-down menus. Refer to the following example.

   

5. Fill in Notification Settings.

   

6. Review the summary and click Add.

7. A window pops up where you can copy your Client ID and Client Secret.

   

   Store the Client ID and Client Secret in a safe location.

8. Click Close.

Adding the Connector in Stellar Cyber

To add a Mimecast connector in Stellar Cyber:

1. Log in to Stellar Cyber.

2. Click System | Connectors (under Integrations). The Connector Overview appears.

   

3. Click Create. The General tab of the Add Connector screen appears. The information on this tab cannot be changed after you add the connector.

   

   The asterisk (*) indicates a required field.

4. Choose Email from the Category drop-down.

5. Choose Mimecast API 2.0 from the Type drop-down.

6. For this connector, the supported Function is Collect, which is enabled already.

7. Enter a Name.

   Notes:

   • This field does not accept multibyte characters.
   • It is recommended that you follow a naming convention such as tenantname-connectortype.

8. Choose a Tenant Name. The Interflow records created by this connector include this tenant name.

9. Choose the device on which to run the connector.

10. (Optional) When the Function is Collect, you can apply Log Filters. For information, see Managing Log Filters.

11. Click Next. The Configuration tab appears.

    

    The asterisk (*) indicates a required field.

12. Enter the Base URL you noted above in Obtaining Mimecast Credentials.

13. Enter the Client ID you noted above.

14. Enter the Client Secret you noted above.

15. Choose the Content Type you would like to collect. The logs for MTA Log are supported.

16. Choose the Log Event Type you would like to collect. The following log event types are supported:

    • Attachment Protect

    • AV

    • Delivery

    • Impersonation Protect

    • Internal Email Protect

    • Journal

    • Process

    • Receipt

    • Spam

    • URL Protect

17. Click Next. The final confirmation tab appears.

    

18. Click Submit.

The new connector is immediately active.

Testing the Connector

In addition to testing for connectivity, the Test button for the Mimecast API 2.0 connector tests that the Base URL and Client ID/Client Secret are correct and data requests for the requested content type return successful responses.

When you add (or edit) a connector, we recommend that you run a test to validate the connectivity parameters you entered. (The test validates authentication and connectivity).

For connectors running on a sensor, Stellar Cyber recommends that you allow 30-60 seconds for new or modified configuration details to be propagated to the sensor before performing a test.

1. Click System | Connectors (under Integrations). The Connector Overview appears.

   

2. Locate the connector by name that you added, or modified, or that you want to test.

3. Click Test at the right side of that row. The test runs immediately.

   Note that you may run only one test at a time.

Verifying Ingestion

To verify ingestion:

1. Click Investigate | Threat Hunting. The Interflow Search tab appears.
2. Change the Indices to Syslog. The table immediately updates to show ingested Interflow records.