@cryptotaxi247 / CoPilot
Code Commits Issues Pulls Sessions CI/CD
main
main
md 86 lines 4.19 KB
Rendered Raw
1 # [Mimecast](https://integrations.mimecast.com/documentation/api-overview/authentication-scripts-server-apps/)
2
3 # Requirements
4
5 - A Mimecast plan with a Targeted Threat Protection (TTP) license. For more information, see Mimecast Plans.
6 - A Mimecast administrator account.
7
8 # Steps
9
10 1. **Create the API application.**
11 2. **Configure the API service account user.**
12 3. **Configure 2-step authentication with SMS.**
13 4. **Create API keys.**
14 5. **Provide your Mimecast credentials to CoPilot.**
15
16 ## Step 1: Create the API Application
17
18 1. Sign in to the Mimecast Administration Console.
19 2. In the Administration menu, click `Services > API and Platform Integrations`.
20 3. On the Available Integrations tab, click `Generate Keys`.
21 4. In the Description field, enter a description for this API application.
22 5. Click `Next`.
23 6. Configure these settings:
24 - Technical Point of Contact — Enter the name of the person who Mimecast should contact if necessary. For example, the active user configuring the API application.
25 - Email — Enter the corresponding email for the point of contact.
26 7. Click `Next`.
27 8. Verify that your information is correct, and then click the Status toggle to the `Enabled` position.
28 9. Click `Add`.
29 10. Click the application that you created to open the information panel.
30 11. Copy the Application ID and Application Key to a safe, encrypted location to provide to CoPilot later.
31
32 ## Step 2: Configure the API service account user
33
34 To prevent permission overrides during the configuration process, create a dedicated service account user. For more information, see Managing API Applications.
35
36 1. Sign in to the Mimecast Administration Console.
37 2. Create a service account user:
38 - In the Administration menu, click `Directories > Internal Directories`.
39 - Select the domain the user will be added to.
40 - Enter the email address for the user.
41 - Create and confirm a password.
42 - Click `Save`.
43 3. Assign the service account user permissions:
44 - In the Administration menu, click `Account > Roles`.
45 - Click `Basic Administrator`.
46 - Click `Add User to Role`.
47 - Select the email address of the API service user account.
48
49 ## Step 3: Configure 2-step authentication with SMS
50
51 You must configure 2-step authentication with SMS to create the API keys. After creating the API keys, you can revert to your previous authentication method.
52
53 1. In a new browser tab, sign in to the Mimecast Administration Console as the service account user created in Configure the API service account user.
54 2. Register a phone number for the service account that can be used for 2-step authentication with SMS:
55 - Click the flag icon to select the correct country code.
56 - Enter the phone number.
57 - Click `Next`.
58 - Enter the verification sent to the registered phone number.
59 - Click `Verify`.
60 3. Sign out of Mimecast.
61 4. Return to the previous browser tab.
62
63 ## Step 4: Create API keys
64
65 > **Notes:**
66 >
67 > - You may need to wait a maximum of 30 minutes after creating the API application before creating the API keys.
68
69 1. In the browser tab that you just returned to, in the Administration menu, click `Services > API and Platform Integrations`.
70 2. In the Your Application Integrations tab, select the application that you created in Create the API application.
71 3. In the information pane, click `Create Keys`.
72 4. In the Email Address field, enter the email address for the service account that you created in Configure the API service account user.
73 5. Click `Next`.
74 6. In the Type menu, click `Cloud`.
75 7. In the Password field, enter the service account password, and then click `Next`.
76 8. Follow the prompts to verify the service account, and then click `Next`.
77 9. Click the eye next to Access Key and Secret Key to reveal each value.
78 10. Copy the Access Key and Secret Key values and save them in a safe, encrypted location to provide to CoPilot later.
79 11. Click `Finish`.
80
81 ## Step 5: Provide your Mimecast credentials to CoPilot
82
83 1. In the CoPilot web app, click `Customers > **Select the Customer's details** > Integrations`.
84 2. Click `Add Integration`.
85 3. Select `Mimecast` from the list of integrations.
86 4. Enter the Application ID, Application Key, Access Key, Secret Key, and Email Address that you saved in the previous steps.