## Introduction

Mimecast Cloud Gateway is a cloud based email security product. This guide walks you through the steps to gather the necessary information and configure your Mimecast Cloud Gateway tenant for the purpose of creating an integration with Synqly's Email Security connector.

## Prerequisites

Before you begin, ensure that you have:

- Access to a Mimecast Cloud Gateway tenant
- Access to a Mimecast Cloud Gateway account that has permission to read and edit API application permissions as well as permission to manage application roles
- Knowledge of your compliance and data residency needs regarding your Mimecast Cloud Gateway tenant


## Required Application Permissions

| Application Permission | Purpose |
|  --- | --- |
| Security Events and Data Retrieval - Threat and security statistics - Read | Retrieve threats and threat details |


## Required Custom API 2.0 Integration Products

| Product | Purpose |
|  --- | --- |
| Threats, Security Events and Data for CG | Retrieve threat and threat details |


## Generating API Credentials

### Creating a Custom Role

1. Log into your tenants Mimecast Administration Console with a user account that has permission to read and edit API application permissions as well as permission to manage application roles
2. Select **Account > Admin Roles** from the sidebar on the left
3. Select the **New role** button
4. Fill in the fields title *Role Name* and *Description*
5. In the section titled *Security Permissions*, select the **Cannot Manage Roles** option
6. In the section titled *Application Permissions* add all of the required permissions. The required permissions can be found in the section above titled [Required Application Permissions](#required-application-permissions)
7. Select the **Save and Exit**
8. You have now created a new custom role for the integration. Proceed to the next section titled [Creating an API 2.0 Integration](#creating-an-api-20-integration)


For more information on creating and managing Mimecast custom roles, see the [Mimecast Roles - Managing Administrator Roles docs page](https://mimecastsupport.zendesk.com/hc/en-us/articles/34000769966099-Roles-Managing-Administrator-Roles)

### Creating an API 2.0 Integration

1. Select **Integrations > Integrations Hub** from the sidebar on the left
  - Note: A pop up may appear asking you to accept the Mimecast API Terms and Conditions. Accepting these terms is required by Mimecast before being able to access the Integration Hub
2. Select the **Configure New** option in the card titled *Custom API 2.0 Integration*
3. Fill in the fields titled *Application Name* and *Description*.
4. In the dropdown titled *Products*, select all of the required custom API 2.0 integration products. The required custom API 2.0 integration products can be found in the section above titled [Required Custom API 2.0 Integration Products](#required-custom-api-20-integration-products).
5. In the dropdown titled *Application Role*, select the custom role that you created above in the section titled [Creating a Custom Role](#creating-a-custom-role)
6. Fill in the *Technical Point of Contact* and *Email* fields
7. Select the **Save** button. Take note of the *Client ID* and *Client Secret* values and store them in a safe location
8. You have now created a new Mimecast API 2.0 Integration. Proceed to the next section titled [Configuring the Integration](#configuring-the-integration)


For more information on creating and managing Mimecast API 2.0 Integration, see the [Mimecast API & Integrations - Managing API 2.0 for Cloud Gateway docs page](https://mimecastsupport.zendesk.com/hc/en-us/articles/34000360548755-API-Integrations-Managing-API-2-0-for-Cloud-Gateway)

## Configuring the Integration

To configure a new Mimecast Cloud Gateway integration in the Synqly system, provide each of the values as defined below:

| Integration Parameter | Description |
|  --- | --- |
| Client ID | This is the Client ID value gathered when creating a new Mimecast Custom 2.0 Integration in the Mimecast Integration Hub |
| Client Secret | This is the Client Secret value gathered when creating a new Mimecast Custom 2.0 Integration in the Mimecast Integration Hub |
| API Gateway Region | This is the Mimecast region that will process the API traffic and is typically used for compliance and data residency needs. By default, Synqly Mimecast Cloud Gateway integrations use the Global Mimecast API Gateway.  For more information, see the [Mimecast API Gateway documentation](https://developer.services.mimecast.com/api-overview#api-gateway-options) |