Mimecast
Visualize Mimecast accounts, domains, users, map Mimecast users to employees, and monitor changes through queries and alerts.
- Installation
- Authorization
- Data Model
- Types
- Release Notes
Installation
The Mimecast integration ingests account details, internal domains, users, and awareness-training campaigns using the Mimecast API 1.0. Before configuring the integration in JupiterOne, you must create a registered API Application in the Mimecast Administration Console.
Prerequisites
- A Mimecast account with admin access — you must have a Mimecast Administrator role to register API applications and generate credentials.
- Access to JupiterOne with permission to configure integrations.
Creating credentials in Mimecast
- Log in to the Mimecast Administration Console as an administrator.
- Navigate to Administration > Services > API and Platform Integrations.
- Select the Your Application Integrations category.
- Click Add API Application, or open an existing enabled application.
- Note the Application ID and Application Key shown on the application page.
- If you have not already generated access keys, click Create Keys to generate an Access Key and a Secret Key. Save both values — they are shown only once.
Configuration in JupiterOne
To install the Mimecast integration in JupiterOne, navigate to the Integrations tab in JupiterOne and select Mimecast. Click New Instance to begin configuring your integration.
Creating an instance requires the following:
-
The Account Name used to identify the Mimecast account in JupiterOne. Ingested entities will have this value stored in
tag.AccountNamewhen theAccountNametoggle is enabled. -
Description to assist in identifying the integration instance, if desired.
-
Polling Interval that you feel is sufficient for your monitoring needs. You may leave this as
DISABLEDand manually execute the integration. -
Mimecast Access Key — the Access Key generated in the Create Keys step above. This value is used to sign API requests.
-
Mimecast Secret Key — the Secret Key generated in the Create Keys step above. Used together with the Access Key to authenticate requests.
-
Mimecast Application Key — the Application Key for your registered API Application.
-
Mimecast Application ID — the Application ID for your registered API Application.
Click Create once all values are provided to finalize the integration.
Next steps
Now that your integration instance has been configured, it will begin running on the polling interval you provided, populating data within JupiterOne. Continue on to our Instance management guide to learn more about working with and editing integration instances.
Roles
RBAC roles that must be assigned to the integration principal.
Show Roles (1)
Mimecast Administrator
Endpoints
API endpoints that the integration makes requests to.
Show Endpoints (5)
https://us-api.mimecast.com/api/account/get-accounthttps://us-api.mimecast.com/api/awareness-training/campaign/get-campaignshttps://us-api.mimecast.com/api/awareness-training/campaign/get-user-datahttps://us-api.mimecast.com/api/domain/get-internal-domainhttps://us-api.mimecast.com/api/user/get-internal-users
Documentation Links
Links to provider documentation relevant to setup and configuration.
Show Documentation Links (6)
- https://developer.services.mimecast.com/docs/accountmanagement/1/routes/api%2Faccount%2Fget-account/post
- https://developer.services.mimecast.com/docs/awarenesstraining/1/routes/api%2Fawareness-training%2Fcampaign%2Fget-campaigns/post
- https://developer.services.mimecast.com/docs/awarenesstraining/1/routes/api%2Fawareness-training%2Fcampaign%2Fget-user-data/post
- https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api%2Fdomain%2Fget-internal-domain/post
- https://developer.services.mimecast.com/docs/userandgroupmanagement/1/routes/api%2Fuser%2Fget-internal-users/post
- https://mimecastsupport.zendesk.com/hc/en-us/articles/53486642898195
Per-Step Breakdown
Detailed authorization requirements for each ingestion step.
Show all steps (2)
| Step | Roles | Endpoints |
|---|---|---|
| Fetch Awareness Campaigns Enrollment Data | Mimecast Administrator | https://us-api.mimecast.com/api/awareness-training/campaign/get-user-data |
| Fetch Users | Mimecast Administrator | https://us-api.mimecast.com/api/user/get-internal-users |
Entities
The following entities are created:
| Resources | Entity _type | Entity _class |
|---|---|---|
| Account | mimecast_account | Account |
| Awareness_Campaign | mimecast_awareness_campaign | Training |
| Domain | mimecast_domain | Domain |
| User | mimecast_user | User |
Relationships
The following relationships are created:
Source Entity _type | Relationship _class | Target Entity _type |
|---|---|---|
mimecast_account | HAS | mimecast_domain |
mimecast_account | HAS | mimecast_awareness_campaign |
mimecast_domain | HAS | mimecast_user |
mimecast_user | ASSIGNED | mimecast_awareness_campaign |
mimecast_user | COMPLETED | mimecast_awareness_campaign |