Brand Exploit Protect - Integration With Mimecast API 2.0

This guide describes how to integrate Brand Exploit Protect with your Mimecast account.

Brand Exploit Protect can be used without integrating with your Mimecast account. However, to get the best return on your investment, we recommend that it be integrated. This provides the ability to create policies to provide web and email protection from the Brand Exploit Protect dashboard.

Integration requires you to perform the following in the Mimecast Administration Console:

1. Configure Mimecast API 2.0
2. Re-Generate API 2.0 Application Keys

Considerations

Before you start the integration, review the following considerations.

• It is best practice to create a dedicated Brand Exploit Protect user and use it to generate keys. This avoids instances where an employee might leave the company or change roles, and having to assign a different user. See the Brand Exploit Protect: Managing Users page for further details..
• The "Admin IP Range" is currently incompatible with the BEP integration
• If you are using the "Admin IP Range", this is currently incompatible with the BEP integration, but is currently being considered. The best options would be to disable the IP range or continue to use the BEP service without the integration. The latter would only affect the ability to generate policies from the BEP dashboard.

Mimecast API 2.0

To set up API 2.0, please follow the steps outlined below:

Configuring Mimecast API 2.0

 

Mimecast Administration Console

1. Log on to the Mimecast Administration Console.
2. Navigate to Integrations | API and Platform Integrations | Mimecast API 2.0.
3. Click on the box below to accept Application Program Interface Terms and Conditions.
4. Enter Application name, Category,  Products, Application Role, and Description. Then click Next.

Category	Other
Products	Those are the product permissions granted for these API keys. We need the following: User and Group Management Policy Management
Application Role	Basic Administration

5. In the notification settings, enter the Technical point of contact and Email.
6. Review your information, click Add, and Generate Keys.
7. Copy the Client ID and Client Secret key to a safe place, e.g., a secure Password Management system. The secret key will be needed during the BEP integration with the Mimecast API 2.0.

The API credentials will be displayed on your screen. These secrets should be handled carefully and not stored as plain text or sent through any communication channels, as they provide access to your account.

 

If these steps are completed before enabling API 2.0 integration in BEP, store the credentials in a secret manager until the integration is enabled, or discard them at that moment. You will be able to generate new keys for this integration as needed.

 

Re-Generate API 2.0 Application Keys

In case you need to re-generate your API keys:

1. Navigate to Services | Your API 2.0 Applications | Select and click your desired application.
2. A pane will appear with the integration details. Click the Manage API 2.0 Credentials.

A warning message will be displayed. Notifying that this action will invalidate your existing keys. While it will not alter any current policies configured by BEP, it will prevent you from making any new changes to your policy until the new keys are provided.

3. To continue, click on the Generate button.
4. The new credentials will be displayed, allowing you to copy them into BEP.

Brand Exploit Protect

1. Log on to Brand Exploit Protect.
2. Navigate to Settings | General.
3. On the Mimecast Integration widget, click Edit.
4. Enter the Client ID and Client Secret key credentials from the Adcon BEP 2.0 and click the Test New Key button.

5. After receiving a success message, click the Save button to securely store the credentials in BEP.

If there is an error, try pressing the button again to see if it persists. Sometimes, a network issue may cause the test to fail temporarily.

See Also...

• Brand Exploit Protect Guides
• Brand Exploit Protect: The Dashboard 
• Managing API Applications