オフボード マシン API

  • 適用対象: Microsoft Defender for Endpoint, Microsoft Defender for Endpoint Plan 1 and Plan 2

API の説明

Defender for Endpoint からのオフボード デバイス。

前提条件

サポートされるオペレーティング システム

オペレーティング システム サポートされているバージョン
Windows クライアント Windows 11およびWindows 10、バージョン1703以降
Windows Server Windows Server 2019以降;Windows Server 2012 R2およびWindows Server 2016で、Defender for Endpointの新しい統合エージェントを使用した場合
macOS macOS 14以降
Linux サポートされているLinuxディストリビューション

制限事項

  • この API のレート制限は、1 分あたり 100 呼び出しと 1 時間あたり 1,500 呼び出しです。
  • Windowsデバイスでは、オフボーディングAPIを実行するとセンサーサービスが停止されるだけです。 オフボーディングスクリプトのようにオンボーディング情報をレジストリから削除するわけではありません。

アクセス許可

Microsoft では、アクセス許可が可能な限りで少ないロールを使用することをお勧めします。 これにより、組織のセキュリティが向上します。 グローバル管理者は高い特権を持つロールであり、既存のロールを使用できない場合の緊急時に限定する必要があります。

ユーザー資格情報を使用してトークンを取得する場合:

  • ユーザーには適切なロールが割り当てられている必要があります。 詳細については、「 アクセス許可オプション」を参照してください。

  • ユーザーは、デバイス グループの設定に基づいてデバイスにアクセスできる必要があります。 詳細については、「 デバイス グループの作成と管理」を参照してください。

この API を呼び出すには、次のいずれかのアクセス許可が必要です。 アクセス許可の選択方法など、詳細については、「Defender for Endpoint API を使用する」を参照してください。

アクセス許可の種類 アクセス許可 アクセス許可の表示名
アプリケーション Machine.Offboard Offboard machine
委任 (職場または学校のアカウント) Machine.Offboard Offboard machine

HTTP 要求

POST https://api.security.microsoft.com/api/machines/{id}/offboard

デバイスを選択すると、マシン ID が URL に表示されます。 一般に、URL に記載されている 40 桁の英数字です。

要求ヘッダー

名前 タイプ 説明
Authorization String ベアラー {token}。 必須。
Content-Type 文字列 application/json. 必須。

要求本文

要求本文で、JSON オブジェクトに次のパラメーターを指定します。

パラメーター タイプ 説明
コメント String アクションに関連付けるコメント。 必須。

応答

成功した場合、このメソッドは応答本文 200 - Created response コードと Machine Action を 返します。

例

要求

要求の例を次に示します。 JSON コメントが追加されていない場合は、コード 400でエラーが発生します。

POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/offboard

{
  "Comment": "Offboard machine by automation"
}
  • Last updated on