API do computador offboard

  • Aplica-se a: Microsoft Defender for Endpoint, Microsoft Defender for Endpoint Plan 1 and Plan 2

Descrição da API

Exclusão do dispositivo do Defender para Endpoint.

Pré-requisitos

Sistemas operativos suportados

Limitações

  • As limitações de taxa para esta API são 100 chamadas por minuto e 1500 chamadas por hora.
  • Esta API não é suportada em dispositivos macOS ou Linux.
  • A execução da API de exclusão apenas impede a execução do serviço de sensor, mas não remove as informações de inclusão do registo, como faz um script de exclusão.

Permissões

A Microsoft recomenda que utilize funções com o menor número de permissões. Isto ajuda a melhorar a segurança da sua organização. Administrador Global é uma função altamente privilegiada que deve ser limitada a cenários de emergência quando não pode utilizar uma função existente.

Ao obter um token com credenciais de utilizador:

  • O utilizador tem de ter uma função adequada atribuída. Para obter mais informações, consulte: Opções de permissão.

  • O utilizador tem de ter acesso ao dispositivo, com base nas definições do grupo de dispositivos. Para obter mais informações, consulte: Criar e gerir grupos de dispositivos.

É necessária uma das seguintes permissões para chamar esta API. Para saber mais, incluindo como escolher permissões, veja Utilizar as APIs do Defender para Endpoint

Tipo de permissão Permissão Nome a apresentar da permissão
Aplicação Machine.Offboard Offboard machine
Delegado (conta escolar ou profissional) Machine.Offboard Offboard machine

Pedido HTTP

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

O ID do computador pode ser encontrado no URL quando seleciona o dispositivo. Geralmente, é um número alfanumérico de 40 dígitos que pode ser encontrado no URL.

Cabeçalhos de pedido

Name Tipo Descrição
Autorização Cadeia Portador {token}. Obrigatório.
Tipo de Conteúdo cadeia application/json. Obrigatório.

Corpo do pedido

No corpo do pedido, forneça um objeto JSON com os seguintes parâmetros:

Parâmetro Tipo Descrição
Comentar Cadeia Comentário a associar à ação. Obrigatório.

Resposta

Se for bem-sucedido, este método devolve 200 - Created response o código e a Ação da Máquina no corpo da resposta.

Exemplos:

Pedido

Eis um exemplo do pedido. Se não houver nenhum comentário JSON adicionado, erros com o código 400.

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

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