Configuration - Managing API 2.0 for Cloud Integrated

Updated

This article contains information on creating, updating, generating keys for, and deleting an API 2.0 application within Email Security Cloud Integrated, including necessary prerequisites and steps for each process.

Prerequisites

  • The administrator has a Full Administrator or Super Administrator role.

Creating an API 2.0 Application

You can create an API 2.0 Application, by using the following steps:

  1. Log in to Email Security Cloud Integrated.
  2. Navigate to Integrations | API 2.0 Applications.
  3. Select New Application.

  1. The New Application page is shown and has several sections:

    • Details - Complete the fields as required.

The optional Integration Partner field does not represent a specific integration partner or tool but serves as a description. 

    • Products - Select the minimum set of Products the App needs to access to function.
    • Roles - Select a Role to assign permissions to your application. You should select the minimum level of permissions required for the App to function.
    • Contact - If there is an issue with your Application, Mimecast will contact the person or group listed in this section. Typically, a distribution list works better than a single person to preserve the longevity and ensure fast resolution.

  1. When completed, select Save & Generate Keys.

Everything not marked Optional must be completed for the Save & Generate Keys button to be clickable.

  1. Copy the Client ID and Secret to a safe location (e.g., a password vault), as they will not be shown again. Losing these credentials means you will need to create a new Application.
  2. Mimecast recommends that you read API 2.0 Overview and API 2.0 References before starting your implementation.
    • These documents can also be accessed from the Documentation drop-down in the API 2.0 Portal.

Updating an API 2.0 Application

You can update an existing API 2.0 application, by using the following steps:

  1. Log in to Email Security Cloud Integrated.
  2. Navigate to Integrations | API 2.0 Applications.
  3. Locate your API 2.0 application and click on it.
  4. Make your changes in the View/Edit API App screen and click on Save.
     

    Application Names cannot be updated

Generate Keys for an API 2.0 Application

You can generate keys for an existing API 2.0 application, by using the following steps:

  1. Log in to Email Security Cloud Integrated.
  2. Navigate to Integrations | API 2.0 Applications.
  3. Locate your API 2.0 application and click on it.
  4. In the View/Edit API App screen, click on Generate Keys.

  5. Confirm the Generate New Keys operation by clicking on in the confirmation dialog box that appears.

  6. You are shown the new Client ID and Secret when the new keys have been successfully generated.

  7. Copy the Client ID and Secret to a safe location (e.g., a password vault), as they will not be shown again. Losing these credentials means you will need to create a new Application.
 

Deleting an API 2.0 Application

You can delete an existing API 2.0 application, by using the following steps:abc

  1. Login to the Email Security Cloud Integrated Console.
  2. Navigate to Integrations | API 2.0 Applications.
  3. Locate your API 2.0 application and click on it.
  4. Click on Delete, to delete the application in the View/Edit API App screen.

  5. 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.

See Also...

 
 

Related to

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.