Führt Aktionen für eine Reihe bestimmter E-Mail-Nachrichten durch, einschließlich des Löschens einer E-Mail-Nachricht, des Isolierens einer E-Mail-Nachricht und des Wiederherstellens einer unter Quarantäne gestellten E-Mail-Nachricht.
HTTPS-Anforderung
POST https://<serviceURL>/v1/mitigation/mails
Anforderungsparameter
Die Anforderung muss die erforderlichen Parameter enthalten.
|
Parameter |
Beschreibung |
|---|---|
|
Erforderlicher Parameter |
|
|
action_type |
Aktion, die für eine E-Mail-Nachricht ausgeführt werden soll. Zu den Optionen gehören:
Anmerkung:
Für Gmail wird nur MAIL_DELETE unterstützt.
Anmerkung:
Die MAIL_RESTORE-Aktion wird nur für Exchange Online unterstützt. In Quarantäne befindliche E-Mail-Nachrichten können auch manuell über das Fenster Quarantäne auf der Cloud App Security-Management-Konsole wiederhergestellt werden. |
|
service |
Name des geschützten Diensts, für den die API gilt. Zu den Optionen gehören:
|
|
account_provider |
Name des geschützten Diensts. Zu den Optionen gehören:
|
|
mailbox |
E-Mail-Adresse einer E-Mail-Nachricht zum Durchführen von Aktionen |
|
mail_message_id |
Internet-Nachrichten-ID einer E-Mail-Nachricht, für die eine Aktion durchgeführt werden soll Sie kann über die API Sweeping von E-Mail-Nachrichten oder die Quarantäne-Ereignisse abrufen-API von Cloud App Security oder die Microsoft Graph-API abgerufen werden. Um diese API ordnungsgemäß zu verwenden, geben Sie mindestens eine mail_message_id und eine mail_unique_id ein. Trend Micro empfiehlt, beide in der Anforderungen bereitzustellen. Anmerkung:
Dieser Parameter ist für Gmail optional. |
|
mail_unique_id |
Eindeutige ID einer E-Mail-Nachricht, für die eine Aktion durchgeführt werden soll Sie kann über die API Sweeping von E-Mail-Nachrichten oder die Quarantäne-Ereignisse abrufen-API von Cloud App Security oder die Microsoft Graph-API abgerufen werden. Um diese API ordnungsgemäß zu verwenden, geben Sie mindestens eine mail_message_id und eine mail_unique_id ein. Trend Micro empfiehlt, beide in der Anforderungen bereitzustellen. |
|
mail_message_delivery_time |
Datum und Uhrzeit, zu der eine E-Mail-Nachricht, für die eine Aktion durchgeführt werden soll, gesendet wird Sie kann über die API Sweeping von E-Mail-Nachrichten oder die Quarantäne-Ereignisse abrufen-API von Cloud App Security, die Microsoft Graph-API oder die EWS-API abgerufen werden. |
|
detection_time |
Datum und Uhrzeit, wann das Sicherheitsereignis entdeckt wurde Dies gilt nur für die MAIL_RESTORE-Aktion und kann über die Cloud App Security Quarantäne-Ereignisse abrufen-API abgerufen werden. |
|
mail_log_id |
ID, die ein Protokollelement eindeutig identifiziert Dies gilt nur für die MAIL_RESTORE-Aktion und kann über die Cloud App Security Quarantäne-Ereignisse abrufen-API abgerufen werden. |
Beispiel anfordern
POST https://api.tmcas.trendmicro.com/v1/mitigation/mails
Authorization: Bearer 1de231142eef3f83928da98dc251fbebb6cafe77
Content-Type: application/json
[
{
"action_type": "MAIL_DELETE",
"service": "gmail",
"account_provider": "google",
"mailbox": "user1@example1.com",
"mail_message_id": "<HK0PR06MB28364369C4D9F8255DBB229081410@HK0PR77MB2836.apcprd06.prod.example1.com>",
"mail_unique_id": "AAMkAGRhODQyZDAzLWNmNjEtNDY7OS1iOWM3LWVmODUxMDk4ZjE1ZgBGAAAAAAABcyFCsOdnTohKgA0TJdjUB
wAYbtU+cD0jRZmfu0kuMtvEAAAAAAEMAAAYbtU+cD0jRZmfu0kuMtvEAAF/JGRaAAA=",
"mail_message_delivery_time":"2019-03-15T07:44:27.000Z"
},
{
"action_type": "MAIL_QUARANTINE",
"service": "exchange",
"account_provider": "office365",
"mailbox": "user2@example2.com",
"mail_message_id": "<RK0PR06MB28364369C4D9F8255DBB779081410@HK0PR06MB2836.apcprd04.prod.example2.com>",
"mail_unique_id": "BAMkAGRhODQyZDAzLWNmNjEtNDY2OS1iOWM7LWVmODUxMDk4ZjE1ZgBGAAAAAAABcyFCsOdnTohKgA0TJdjUB
wAYbtU+cD0jRZmfu0kuMtvEAAAAAAEMAAAYbtU+cD0jRZmfu0kuMtvEAAF/JGRaAAA=",
"mail_message_delivery_time":"2019-03-15T07:45:27.000Z"
},
{
"action_type": "MAIL_RESTORE",
"service": "exchange",
"account_provider": "office365",
"mailbox": "user3@example3.onmicrosoft.com",
"detection_time": "2021-10-25T09:51:26.697Z",
"mail_unique_id": "AAkALgAAAAAAHYQDEapmEc2byACqAC-EWg0AJUMWJ_w_F0WJ1OxbHWzuuAABMEsyEwAA",
"mail_log_id": "1d9f27ea-3579-11ec-8159-00224809f763",
"mail_message_id": "<HK0PR02MB3698C584C7E6844016D0455C98839@HK0PR02MB3698.apcprd02.prod.example4.com>",
"mail_message_delivery_time": "2021-10-25T09:51:00.000Z"
}
]
HTTP-Anforderungstext
Der Anforderungstext besteht aus einer Reihe von E-Mail-Nachrichten mit detaillierten Informationen über jede einzelne Nachricht.
Antwort
Bei Erfolg sendet der Dienst eine HTTP 201-Antwort zurück und gibt einen Anforderungstext im JSON-Format zurück; andernfalls sendet der Dienst eine Fehlermeldung im JSON-Format mit Fehlerdetails zurück. Weitere Informationen zu Fehlern finden Sie unter API-Antworten.
Antwortbeispiel
HTTP/1.1 201
Content-Type: application/json
{
"code": 0,
"msg": "",
"batch_id": "3fa85f64-5717-4562-b3fc-2c963f66af77"
"tracdId": "cabdfasdfdasfdsab-411f-a222-33ec6f44cc77"
}
Antwortfelder
In der folgenden Tabelle werden die verfügbaren Felder für den Antworttext beschrieben.
|
Feld |
Datentyp |
Beschreibung |
|---|---|---|
|
code |
Ganzzahl |
Ergebniscode der Anforderung. Bei einer HTTP-200-Antwort ist der Wert auf 0 festgelegt |
|
msg |
Zeichenfolge |
Zeichenfolge, die den Ergebniscode beschreibt. Bei einer HTTP 200-Antwort ist der Wert NULL |
|
batch_id |
Zeichenfolge |
Eindeutige ID der API-Anforderung, einschließlich aller durchzuführenden Aktionen für E-Mail-Nachrichten, die in dieser Anforderung angegeben werden Sie können damit die Ergebnisse der Aktion abfragen. Weitere Informationen finden Sie unter Aktionsergebnisse abfragen. |
|
traceId |
Zeichenfolge |
Zufällig generierte Identität, um die Anforderung eindeutig zu verfolgen |