|
| 1 | +# Description |
| 2 | + |
| 3 | +[Mimecast](https://www.mimecast.com) is a set of cloud services designed to provide next generation protection against advanced email-borne threats such as malicious URLs, malware, impersonation attacks, as well as internally generated threats, with a focus on email security. This plugin utilizes the [Mimecast API](https://www.mimecast.com/developer/documentation) |
| 4 | + |
| 5 | +# Key Features |
| 6 | + |
| 7 | +* Email security |
| 8 | +* Malicious URL and attachment detection |
| 9 | + |
| 10 | +# Requirements |
| 11 | + |
| 12 | +* Mimecast 2.0 Application Client ID |
| 13 | +* Mimecast 2.0 Application Client Secret |
| 14 | + |
| 15 | +# Supported Product Versions |
| 16 | + |
| 17 | +* Mimecast 2.0 API 2025-01-23 |
| 18 | + |
| 19 | +# Documentation |
| 20 | + |
| 21 | +## Setup |
| 22 | + |
| 23 | +The connection configuration accepts the following parameters: |
| 24 | + |
| 25 | +|Name|Type|Default|Required|Description|Enum|Example|Placeholder|Tooltip| |
| 26 | +| :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | |
| 27 | +|client_id|credential_secret_key|None|True|The Mimecast 2.0 Application Client ID|None|ZA7vkbu7NqcfBcGrXyWW8Rzk2sv2un2DCY7GGCX4BFWgJBZM|None|None| |
| 28 | +|client_secret|credential_secret_key|None|True|The Mimecast 2.0 Application Client Secret|None|ohknqKJpCd99XTkHjeVuc2TgYaKWrWn4tEEHCLkXFZhFgDRdcpNGVx3EipX2CvmE|None|None| |
| 29 | + |
| 30 | +Example input: |
| 31 | + |
| 32 | +``` |
| 33 | +{ |
| 34 | + "client_id": "ZA7vkbu7NqcfBcGrXyWW8Rzk2sv2un2DCY7GGCX4BFWgJBZM", |
| 35 | + "client_secret": "ohknqKJpCd99XTkHjeVuc2TgYaKWrWn4tEEHCLkXFZhFgDRdcpNGVx3EipX2CvmE" |
| 36 | +} |
| 37 | +``` |
| 38 | + |
| 39 | +## Technical Details |
| 40 | + |
| 41 | +### Actions |
| 42 | + |
| 43 | +*This plugin does not contain any actions.* |
| 44 | +### Triggers |
| 45 | + |
| 46 | +*This plugin does not contain any triggers.* |
| 47 | +### Tasks |
| 48 | + |
| 49 | + |
| 50 | +#### Monitor SIEM Logs |
| 51 | + |
| 52 | +This task is used to monitor and retrieve the latest logs |
| 53 | + |
| 54 | +##### Input |
| 55 | + |
| 56 | +*This task does not contain any inputs.* |
| 57 | + |
| 58 | +##### Output |
| 59 | + |
| 60 | +|Name|Type|Required|Description|Example| |
| 61 | +| :--- | :--- | :--- | :--- | :--- | |
| 62 | +|data|[]object|True|List of logs|[{"processingId": "processingId", "aggregateId": "aggregateId", "spamProcessingDetail": "Spam Processing Detail", "numberAttachments": "1", "subject": "siem_recipient - email subject line", "tlsVersion": "TLSv1.2", "senderEnvelope": "user@example.com", "messageId": "messageId", "senderHeader": "user@example.com", "rejectionType": "rejectionType", "eventType": "receipt", "accountId": "C0A0", "recipients": "user@example.com", "tlsCipher": "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "action": "Allow", "subType": "Allow", "spamInfo": None, "senderIp": "123.123.123.123", "timestamp": 1689685338597, "direction": "Inbound", "spamScore": "0", "spamDetectionLevel": "0"}]| |
| 63 | + |
| 64 | +Example output: |
| 65 | + |
| 66 | +``` |
| 67 | +{ |
| 68 | + "data": [ |
| 69 | + { |
| 70 | + "accountId": "C0A0", |
| 71 | + "action": "Allow", |
| 72 | + "aggregateId": "aggregateId", |
| 73 | + "direction": "Inbound", |
| 74 | + "eventType": "receipt", |
| 75 | + "messageId": "messageId", |
| 76 | + "numberAttachments": "1", |
| 77 | + "processingId": "processingId", |
| 78 | + "recipients": "user@example.com", |
| 79 | + "rejectionType": "rejectionType", |
| 80 | + "senderEnvelope": "user@example.com", |
| 81 | + "senderHeader": "user@example.com", |
| 82 | + "senderIp": "123.123.123.123", |
| 83 | + "spamDetectionLevel": "0", |
| 84 | + "spamInfo": null, |
| 85 | + "spamProcessingDetail": "Spam Processing Detail", |
| 86 | + "spamScore": "0", |
| 87 | + "subType": "Allow", |
| 88 | + "subject": "siem_recipient - email subject line", |
| 89 | + "timestamp": 1689685338597, |
| 90 | + "tlsCipher": "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", |
| 91 | + "tlsVersion": "TLSv1.2" |
| 92 | + } |
| 93 | + ] |
| 94 | +} |
| 95 | +``` |
| 96 | + |
| 97 | +### Custom Types |
| 98 | + |
| 99 | +*This plugin does not contain any custom output types.* |
| 100 | + |
| 101 | +## Troubleshooting |
| 102 | + |
| 103 | + |
| 104 | +# Version History |
| 105 | + |
| 106 | +* 1.0.0 - Initial plugin |
| 107 | + |
| 108 | +# Links |
| 109 | + |
| 110 | +* [Mimecast](http://mimecast.com) |
| 111 | + |
| 112 | +## References |
| 113 | + |
| 114 | +* [Mimecast API](https://www.mimecast.com/developer/documentation) |
0 commit comments