シミュレーションを更新する

名前空間: microsoft.graph

テナントの 攻撃シミュレーション キャンペーン を更新します。 更新できるのは、 draft 状態のシミュレーションのみです。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国
✅ ❌ ❌ ❌

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。

アクセス許可の種類 最小特権アクセス許可 より高い特権のアクセス許可
委任 (職場または学校のアカウント) AttackSimulation.ReadWrite.All 注意事項なし。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション AttackSimulation.ReadWrite.All 注意事項なし。

HTTP 要求

PATCH /security/attackSimulation/simulations/{simulationId}

要求ヘッダー

ヘッダー 値
Authorization ベアラー {token}。 必須です。 認証と認可についての詳細をご覧ください。
Content-Type application/json

要求本文

要求本文で、更新するプロパティの値 のみを 指定します。 要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。

次の表に、更新できるプロパティを示します。

プロパティ 型 説明
attackTechnique simulationAttackTechnique 攻撃シミュレーションとトレーニング キャンペーンで使用されるソーシャル エンジニアリング手法。 $filter と $orderby をサポートします。 使用可能な値は、 unknown、 credentialHarvesting、 attachmentMalware、 driveByUrl、 linkInAttachment、 linkToMalwareFile、 unknownFutureValue、 oAuthConsentGrantです。 Prefer: include-unknown-enum-members要求ヘッダーを使用して、この進化可能な列挙型から次の値を取得します:oAuthConsentGrant。 ソーシャル エンジニアリング攻撃手法の種類の詳細については、「 シミュレーション」を参照してください。
attackType simulationAttackType 攻撃シミュレーションとトレーニング キャンペーンの攻撃の種類。 使用可能な値: unknown、social、cloud、endpoint、unknownFutureValue。
displayName 文字列 攻撃シミュレーションとトレーニング キャンペーンの表示名。 $filter と $orderby をサポートします。
durationInDays Int32 シミュレーション期間 (日数)。
excludedAccountTarget accountTargetContent シミュレーションから除外されたユーザー。
includedAccountTarget accountTargetContent シミュレーションの対象となるユーザー。
payload ペイロード シミュレーションに関連付けられたペイロード。 必須です。
status simulationStatus 攻撃シミュレーションとトレーニング キャンペーンの状態。 使用可能な値は、 unknown、 draft、 running、 scheduled、 succeeded、 failed、 cancelled、 excluded、 unknownFutureValueです。

応答

このメソッドは、 202 Accepted 応答コードと、操作の結果を判断するためにポーリングする必要がある応答に location という名前の追跡ヘッダーを返します。

例

例 1: 攻撃シミュレーション キャンペーンを更新する

次の例は、テナントの攻撃シミュレーション キャンペーンを更新する方法を示しています。

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/v1.0/security/attackSimulation/simulations/2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc
Content-type: application/json

{
  "@odata.etag": "\"0100aa9b-0000-0100-0000-6396fa270000\"",
  "displayName": "Graph Simulation",
  "payload@odata.bind":"https://graph.microsoft.com/v1.0/security/attacksimulation/payloads/12345678-9abc-def0-123456789a",
  "durationInDays": 7,
  "attackTechnique": "credentialHarvesting",
  "attackType": "social",
  "status": "scheduled",
  "includedAccountTarget": {
    "@odata.type": "#microsoft.graph.addressBookAccountTargetContent",
    "type" : "addressBook",
    "accountTargetEmails" : [
        "faiza@contoso.com"
    ]
  },
  "excludedAccountTarget": {
    "@odata.type": "#microsoft.graph.addressBookAccountTargetContent",
    "type" : "addressBook",
    "accountTargetEmails" : [
        "sam@contoso.com"
    ]
  }
}

応答

次の例は応答を示しています。

HTTP/1.1 202 Accepted

例 2: 攻撃シミュレーション キャンペーンを下書きからスケジュール済みに更新する

次の例は、攻撃シミュレーション キャンペーンをスケジュールする方法を示しています。 シミュレーション要求は、シミュレーションをスケジュールするときに検証されます。 必要なすべてのパラメーターをそのような要求に反映する必要があります。

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/v1.0/security/attackSimulation/simulations/2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc
Content-type: application/json

{
  "@odata.etag": "\"0100aa9b-0000-0100-0000-6396fa270000\"",
  "id": "2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc",
  "displayName": "Graph Simulation",
  "payload@odata.bind":"https://graph.microsoft.com/v1.0/security/attacksimulation/payloads/12345678-9abc-def0-123456789a",
  "durationInDays": 7,
  "attackTechnique": "credentialHarvesting",
  "attackType": "social",
  "status": "scheduled",
  "includedAccountTarget": {
    "@odata.type": "#microsoft.graph.addressBookAccountTargetContent",
    "type" : "addressBook",
    "accountTargetEmails" : [
        "faiza@contoso.com"
    ]
  },
  "excludedAccountTarget": {
    "@odata.type": "#microsoft.graph.addressBookAccountTargetContent",
    "type" : "addressBook",
    "accountTargetEmails" : [
        "sam@contoso.com"
    ]
  }
}

応答

次の例は応答を示しています。

HTTP/1.1 202 Accepted

例 3: 攻撃シミュレーション キャンペーンをキャンセルする

次の例は、テナントの攻撃シミュレーション キャンペーンをキャンセルする方法を示しています。 シミュレーションの状態が scheduled または runningのときに、シミュレーションを取り消すことができます。

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/v1.0/security/attackSimulation/simulations/2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc
Content-type: application/json

{
  "@odata.etag": "\"0100aa9b-0000-0100-0000-6396fa270000\"",
  "id": "2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc",
  "status": "cancelled"
}

応答

次の例は応答を示しています。

HTTP/1.1 202 Accepted

例 4: 攻撃シミュレーション キャンペーンを除外する

次の例は、テナントの攻撃シミュレーション キャンペーンを除外する方法を示しています。 シミュレーションをレポートから除外できるのは、その状態が cancelled場合のみです。

要求

次の例は要求を示しています。

PATCH https://graph.microsoft.com/v1.0/security/attackSimulation/simulations/2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc
Content-type: application/json

{
  "@odata.etag": "\"0100aa9b-0000-0100-0000-6396fa270000\"",
  "id": "2f5548d1-0dd8-4cc8-9de0-e0d6ec7ea3dc",
  "status": "excluded"
}

応答

次の例は応答を示しています。

HTTP/1.1 202 Accepted