Dela via

API för avregistreringsdator

  • Artikel

Gäller för:

Vill du uppleva Microsoft Defender för Endpoint? Registrera dig för en kostnadsfri utvärderingsversion.

Obs!

Om du är en us government-kund använder du de URI:er som anges i Microsoft Defender för Endpoint för amerikanska myndighetskunder.

Tips

För bättre prestanda kan du använda servern närmare din geoplats:

  • 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

API-beskrivning

Avregistrera enheten från Defender för Endpoint.

Begränsningar

  • Hastighetsbegränsningar för det här API:et är 100 anrop per minut och 1 500 anrop per timme.

    Obs!

    Den här sidan fokuserar på att utföra en datoråtgärd via API. Mer information om svarsåtgärder via Microsoft Defender för Endpoint finns i Vidta svarsåtgärder på en dator.

Obs!

  • Det här API:et stöds på Windows 11, Windows 10 version 1703 och senare, i Windows Server 2019 och senare, och på Windows Server 2012 R2 och Windows Server 2016 när du använder den nya enhetliga agenten för Defender för Endpoint.
  • Det här API:et stöds inte på macOS- eller Linux-enheter.
  • Att köra offboarding-API:et hindrar bara sensortjänsten från att köras, men den tar inte bort registreringsinformationen från registret som ett avregistreringsskript gör.

Behörigheter

En av följande behörigheter krävs för att anropa det här API:et. Mer information, inklusive hur du väljer behörigheter, finns i Använda Defender för Endpoint-API:er

Behörighetstyp Behörighet Visningsnamn för behörighet
Program Machine.Offboard "Avregistreringsmaskin"
Delegerat (arbets- eller skolkonto) Machine.Offboard "Avregistreringsmaskin"

Obs!

När du hämtar en token med användarautentiseringsuppgifter:

  • Användaren måste ha AD-rollen "Global Admin"
  • Användaren måste ha åtkomst till enheten baserat på enhetsgruppsinställningarna (mer information finns i Skapa och hantera enhetsgrupper)

Skapande av enhetsgrupp stöds i Defender för Endpoint Plan 1 och Plan 2.

HTTP-begäran

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

Du hittar dator-ID:t i URL:en när du väljer enheten. I allmänhet är det ett 40-siffrigt alfanumeriskt tal som finns i URL:en.

Frågerubriker

Namn Typ Beskrivning
Tillstånd Sträng Ägaren {token}. Krävs.
Content-Type sträng application/json. Krävs.

Frågebrödtext

I begärandetexten anger du ett JSON-objekt med följande parametrar:

Parameter Typ Beskrivning
Kommentar Sträng Kommentar som ska associeras med åtgärden. Krävs.

Svar

Om det lyckas returnerar den här metoden 200 – Skapad svarskod och Datoråtgärd i svarstexten.

Exempel

Begäran

Här är ett exempel på begäran. Om det inte finns någon JSON-kommentar tillagd kommer den att fela med kod 400.

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

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

Tips

Vill du veta mer? Engage med Microsofts säkerhetscommunity i vår Tech Community: Microsoft Defender för Endpoint Tech Community.