API & Integrations - Managing API 2.0 for Cloud Gateway

This article contains information on prerequisites and steps for creating, updating, deleting, and regenerating keys for an API 2.0 Application in Mimecast, emphasizing role permissions and security settings.

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 | API and Platform Integrations
3. Locate the following Mimecast API 2.0 tile and click on Generate Keys.

4. After reading the Terms & Conditions, complete the I accept check box to enable the Next button to progress onto the next step.
5. Complete the Application Details section.

• We highly recommend creating a dedicated custom role with only the permissions required for the Application to function.
• Select the minimum set of Products the App needs to access to function.

6. Should we need to contact you regarding this API application, please provide details for a Technical Point of Contact.

Mimecast recommends a group rather than an individual contact.

7. Review the Summary information for the API application and click on Add if you are happy to proceed with creating the application.

8. The wizard completes and displays a pop-up window including your Client ID and Client Secret key data, where you can copy and save the credentials for the API application.
   
   
9. Once you have copied the above to a safe location, such as a password vault, Mimecast recommends you read the API 2.0 Overview and API 2.0 References before starting your implementation from the following source: https://developer.services.mimecast.com. Documentation can be accessed from the Documentation drop-down menu (image below).

Updating an API 2.0 Application

To update an existing API Gateway application, follow the steps below:

1. Log in to Mimecast Administration Console.
2. Navigate to Integrations | API and Platform Integrations.
3. Click on the Your API 2.0 Applications tab.
4. Locate your API Application in the table by using the search field or manually locating the entry for the API Application.
5. Click on the entry to show the slide-out panel for the API Gateway Application.
6. Click the Edit button to enter the API Application wizard in edit mode.

The option to Edit an API Application can also be accessed from the meatballs menu icon on the far right-hand side.

7. You will now be in Edit mode; once the Legal terms outlining the conditions of use have been read and understood, fill in the I accept check box and proceed to edit the API Gateway Application.

8. Click on the Details heading on the left; if no further changes are required for Notifications, click Save & Close.

Application Names cannot be updated.

9. Click on the Notifications heading on the left-hand side, make your changes, and click on Save & Close.

Deleting an API 2.0 Application

To delete an API application, follow these steps:

1. Log in to Mimecast Administration Console.
2. Navigate to Administration | Services | API and Platform Integrations.
3. Click on the Your API 2.0 Applications tab.
4. Locate your API Application in the table by using the search field or manually locating the entry for the API Application.
5. Click on the entry to show the slide-out panel for the API Gateway Application.
6. Click on the Delete button to delete the API Application.

7. Confirm the delete operation by clicking on Delete in the confirmation dialog box that appears.

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 in to the Mimecast Administration Console.
2. Navigate to Integrations | API and Platform Integrations.
3. Click on the Your API 2.0 Applications tab.
4. Locate your API Application in the table by using the search field or manually locating the entry for the API Application.
5. Click on the entry to show the slide-out panel for the API Gateway Application.
6. Click on the Manage API 2.0 Credentials button to update the API Credentials for the API Application.

7. The Generate New Keys pop-up box will open, click Generate to create a new Client ID and Client Secret keys.

8. Copy and save the new key data to a safe and secure location.

See Also...

• Mimecast Developer
• API & Integrations - Managing API Applications