API & Integrations - Managing API 2.0 for Cloud Gateway

This article contains information on managing API 2.0 applications during Mimecast’s migration to the Integrations Hub, including creation, updates, deletion, and key regeneration.

Migration to the Integrations Hub

Mimecast is in the process of moving management of all API 2.0 applications from the API and Platform Integrations page to the Integrations Hub. During this process, older apps may still be managed on the API and Platform Integrations page, and all newly created apps should be managed from the Integrations Hub.

Prerequisites

The designated 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.

Custom roles should be created for each API 2.0 Application with the least required privileges applied.

Creating an API 2.0 Application

To create an API 2.0 Application, follow the steps below:

1. Log in to Mimecast Administration Console.
2. Navigate to Integrations | Integrations Hub.
3. If you haven't accepted before, you may see a popup asking you to accept our API Terms and Conditions. Review and accept these terms before creating any API applications.
4. Locate the following Mimecast API 2.0 tile and click Configure New.

5. Under Details, populate the following fields:

• Application Name: A name to uniquely identify this application. Once saved, this value cannot be changed.
• Products: The API products that will be used, which are categories of API endpoints. The products are a one-to-one mapping with the tiles on our API documentation. Once saved, the products cannot be modified.
• Application Role: The administrative role to scope what this API application is allowed to do. Roles can be managed under Account | Admin Roles.
• Description: A free-form text field that can be used to described the application and its purpose. This can be modified after the app has been created.

6. Under Notification Settings, populate the following fields:
    

• Technical Point of Contact: The name of the person or team that should be notified if we need to reach out about the specific application.
• Email: The email address of the person to be contacted, if needed. This can be a user or a group address.

7. Click Save.
8. A popup will appear with a masked Client ID and Client Secret. Copy these to a secure location, as the secret will not be shown again.

9. Once saved, click Close.

Updating an API 2.0 Application

1. Log into the Mimecast Administration Console.
2. Navigate to Integrations | Integrations Hub.
3. Locate the API 2.0 tile and click View.

4. Find and click on the application that you wish to modify.

This action can also be accessed by clicking on the meatball icon.

5. Change the fields as needed.

6. Click Save.

Deleting an API 2.0 Application

To delete an API application, follow these steps:

1. Log into the Mimecast Administration Console.
2. Navigate to Integrations | Integrations Hub.
3. Locate the API 2.0 tile and click View.

4. Find and click on the application you want to delete.

This action can also be accessed by clicking on the meatball icon.

5. Click Delete.

6. Confirm that you want to delete the application by clicking Delete.

Credentials for this API Application will no longer be valid from this point forward.

Regenerating Keys

To generate a new, fresh Client ID and Secret Keys, follow these steps:

1. Log into the Mimecast Administration Console.
2. Navigate to Integrations | Integrations Hub.
3. Locate the API 2.0 tile and click View.

4. Find and click on the application for which you want to generate new keys.

5. Click Reset Keys.

6. Click Regenerate to confirm you want to obtain a new set of keys.

7. A popup will appear with a masked Client ID and Client Secret. Copy these to a secure location, as the secret will not be shown again.

8. Once saved, click Close.

Legacy Keys Generated Under API and Platforms Integrations

If you've previously an API 2.0 application on the API and Platform Integrations section of the Administration Console, those will continue to be managed on that page at this time. In future, we will automatically move these to the Integrations Hub.

New applications will only be managed on the Integrations Hub.

Steps to manage an older application

1. Log into the Mimecast Administration Console.
2. Navigate to Integrations | API and Platform Integrations.
3. Click on the API 2.0 Applications tab.
4. Click on the application you wish to manage.
5. Select an action flyout:

• Edit: Modify information about the application, products, roles and notification contact information.
• Manage API 2.0 Credentials: This will generate a new set of API keys for this app.
• Delete: Remove this integration and its associated API keys if no longer needed.

This page uses an older management experience, where sections are selected on the left (Disclaimer, Details, Notifications).

See Also...

• Mimecast Developer
• API & Integrations - Managing API Applications