API de machine hors-bord

Description de l’API

Désintégez l’appareil de Defender pour point de terminaison.

Configuration requise

Systèmes d’exploitation pris en charge

Système d'exploitation Versions prises en charge
Client Windows Windows 11 et Windows 10, version 1703 et ultérieure
Windows Server Windows Server 2019 et versions ultérieures ; Windows Server 2012 R2 et Windows Server 2016 lors de l’utilisation du nouvel agent unifié pour Defender for Endpoint
macOS (en anglais) macOS 14 et versions ultérieures
Linux Distributions Linux prises en charge

Limitations

  • Les limitations de débit pour cette API sont de 100 appels par minute et de 1 500 appels par heure.
  • Sur les appareils Windows, exécuter l’API de déconnexion ne fait que bloquer le service de capteurs. Il ne supprime pas les informations d’intégration du registre comme le fait un script d’offboarding.

Autorisations

Microsoft vous recommande d’utiliser des rôles disposant du moins d’autorisations. Cela contribue à renforcer la sécurité de votre organisation. Le rôle d’administrateur général dispose de privilèges élevés. Il doit être limité aux scénarios d’urgence lorsque vous ne pouvez pas utiliser un rôle existant.

Lors de l’obtention d’un jeton à l’aide des informations d’identification de l’utilisateur :

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour en savoir plus, notamment sur le choix des autorisations, consultez Utiliser les API Defender pour point de terminaison.

Type d’autorisation Autorisation Nom complet de l’autorisation
Application Machine.Offboard Offboard machine
Déléguée (compte professionnel ou scolaire) Machine.Offboard Offboard machine

Requête HTTP

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

L’ID de machine se trouve dans l’URL lorsque vous sélectionnez l’appareil. En règle générale, il s’agit d’un nombre alphanumérique à 40 chiffres qui se trouve dans l’URL.

En-têtes de demande

Nom Type Description
Autorisation Chaîne Porteur {token}. Obligatoire.
Content-Type string application/json. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez un objet JSON avec les paramètres suivants :

Paramètre Type Description
Commentaire Chaîne Commentaire à associer à l’action. Obligatoire.

Réponse

Si elle réussit, cette méthode retourne 200 - Created response le code et l’action machine dans le corps de la réponse.

Exemple

Demande

Voici un exemple de demande. Si aucun commentaire JSON n’est ajouté, il génère une erreur avec le code 400.

POST https://api.security.microsoft.com/api/machines/1e5bc9d7e413ddd7902c2932e418702b84d0cc07/offboard
{
  "Comment": "Offboard machine by automation"
}