Führt Aktionen für eine Reihe bestimmter Benutzerkonten aus, einschließlich der Deaktivierung eines Benutzerkontos, der Anforderung, die mehrstufige Authentifizierung (MFA) für ein Benutzerkonto zu aktivieren, der Anforderung, das Kennwort für ein Benutzerkonto zurückzusetzen, und der Beendigung aller Anmeldesitzungen von Microsoft-Diensten für ein Benutzerkonto.

HTTPS-Anforderung

POST https://<serviceURL>/v1/mitigation/accounts

Anforderungsparameter

Wichtig:

Die Anforderung muss die erforderlichen Parameter enthalten.

Parameter

Beschreibung

Erforderlicher Parameter

action_type

Aktion, die für ein Benutzerkonto durchgeführt werden soll. Zu den Optionen gehören:

  • ACCOUNT_DISABLE: Deaktiviert ein Benutzerkonto

  • ACCOUNT_ENABLE_MFA: Zwingt einen Benutzer, eine mehrstufige Authentifizierung durchzuführen, bevor er gezwungen wird, sein Kennwort zu ändern

  • ACCOUNT_RESET_PASSWORD: Fordert das Zurücksetzen des Kennworts für ein Benutzerkonto an

  • ACCOUNT_REVOKE_SIGNIN_SESSIONS: beendet die aktuellen Anmeldesitzungen eines Benutzerkontos, sodass sich der Benutzer beim nächsten Mal erneut bei Office 365-Diensten anmelden muss.

Wichtig:

Führen Sie vor der Verwendung der Aktionen ACCOUNT_ENABLE_MFA, ACCOUNT_RESET_PASSWORD und ACCOUNT_REVOKE_SIGNIN_SESSIONS ein PowerShell-Skript aus, um die Rolle Unternehmensadministrator zu Cloud App Security zuzuweisen. Weitere Informationen finden Sie unter Administratorenrolle für Benutzerkonten zuweisen.

Service

Name des geschützten Diensts, für den die API gilt. Zu den Optionen gehören:

  • exchange

account_provider

Name des geschützten Diensts. Zu den Optionen gehören:

  • office365

account_user_email

E-Mail-Adresse, die zum Erstellen des Benutzerkontos verwendet wird

Beispiel anfordern

POST https://api.tmcas.trendmicro.com/v1/mitigation/accounts
Authorization: Bearer 1de231142eef3f83928da98dc251fbebb6cafe77
Content-Type: application/json

[
{
  "action_type": "ACCOUNT_DISABLE",
  "service": "exchange",
  "account_provider": "office365",
  "account_user_email": "user1@example1.com"
},
{
  "action_type": "ACCOUNT_ENABLE_MFA",
  "service": "exchange",
  "account_provider": "office365",
  "account_user_email": "user2@example2.com"
}
]

HTTP-Anforderungstext

Der Anforderungstext besteht aus einer Reihe von Benutzerkonten mit detaillierten Informationen über jedes einzelne Konto.

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-2c963f77afa6"
  "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 201-Antwort ist der Wert auf 0 festgelegt

msg

Zeichenfolge

Zeichenfolge, die den Ergebniscode beschreibt. Bei einer HTTP 201-Antwort ist der Wert NULL

batch_id

Zeichenfolge

Eindeutige ID der API-Anforderung, einschließlich aller Aktionen, die auf Benutzerkonten durchgeführt werden, die in dieser Anforderung angegeben wurden

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