Sdílet prostřednictvím

Offboard machine API

  • Článek

Platí pro:

Chcete používat Defender pro Endpoint? Zaregistrujte se a získejte bezplatnou zkušební verzi,

Poznámka

Pokud jste zákazníkem státní správy USA, použijte identifikátory URI uvedené v programu Microsoft Defender for Endpoint pro zákazníky státní správy USA.

Tip

Pro lepší výkon můžete použít server blíže k vašemu geografickému umístění:

  • us.api.security.microsoft.com
  • eu.api.security.microsoft.com
  • uk.api.security.microsoft.com
  • au.api.security.microsoft.com
  • swa.api.security.microsoft.com

Popis rozhraní API

Offboarding zařízení z Defenderu for Endpoint

Omezení

  • Omezení rychlosti pro toto rozhraní API jsou 100 volání za minutu a 1 500 volání za hodinu.

    Poznámka

    Tato stránka se zaměřuje na provedení akce počítače prostřednictvím rozhraní API. Další informace o funkcích akcí odpovědí prostřednictvím Microsoft Defenderu for Endpoint najdete v tématu Provádění akcí odpovědí na počítači .

Poznámka

  • Toto rozhraní API je podporováno ve Windows 11, Windows 10 verze 1703 a novějších verzích. ve Windows Serveru 2019 a novějším; a ve Windows Serveru 2012 R2 a Windows Serveru 2016 při použití nového sjednoceného agenta pro Defender for Endpoint.
  • Toto rozhraní API se nepodporuje na zařízeních s macOS nebo Linuxem.
  • Spuštění rozhraní API pro offboarding pouze zastaví spuštění služby senzoru, ale neodebere informace o připojování z registru jako skript pro offboarding.

Oprávnění

K volání tohoto rozhraní API se vyžaduje jedno z následujících oprávnění. Další informace, včetně postupu výběru oprávnění, najdete v tématu Použití rozhraní Defender for Endpoint API.

Typ oprávnění Povolení Zobrazovaný název oprávnění
Application Machine.Offboard Offboard machine
Delegovaný (pracovní nebo školní účet) Machine.Offboard Offboard machine

Důležité

Microsoft doporučuje používat role s co nejmenším počtem oprávnění. To pomáhá zlepšit zabezpečení vaší organizace. Globální správce je vysoce privilegovaná role, která by měla být omezená na nouzové scénáře, když nemůžete použít existující roli.

Poznámka

Při získávání tokenu pomocí přihlašovacích údajů uživatele:

  • Uživatel musí mít roli globálního správce.
  • Uživatel musí mít přístup k zařízení na základě nastavení skupiny zařízení. Další informace najdete v tématu Vytváření a správa skupin zařízení.

Vytváření skupin zařízení je podporováno v defenderu for Endpoint Plan 1 a Plan 2.

Požadavek HTTP

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

ID počítače najdete v adrese URL, když vyberete zařízení. Obecně se jedná o 40místné alfanumerické číslo, které najdete v adrese URL.

Hlavičky požadavků

Name (Název) Typ Popis
Oprávnění String Nosný {token}. Povinné.
Typ obsahu řetězec application/json. Povinné.

Text požadavku

V textu požadavku zadejte objekt JSON s následujícími parametry:

Parametr Typ Popis
Komentování String Komentář, který chcete přidružit k akci. Povinné.

Odpověď

Pokud je tato metoda úspěšná, vrátí 200 - Created response kód a machine action v těle odpovědi.

Příklad

Prosba

Tady je příklad požadavku. Pokud se nepřidá žádný komentář JSON, dojde k chybě s kódem 400.

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

{
  "Comment": "Offboard machine by automation"
}

Tip

Chcete se dozvědět více? Spojte se s komunitou zabezpečení Microsoftu v naší technické komunitě: Technická komunita Microsoft Defenderu for Endpoint.