컴퓨터 API 오프보딩

API 설명

엔드포인트용 Defender에서 디바이스 오프보딩.

필수 구성 요소

지원되는 운영 체제

운영 체제 지원되는 버전
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의 속도 제한은 분당 100개의 호출과 시간당 1,500건의 호출입니다.
  • Windows 기기에서는 오프보딩 API를 실행하면 센서 서비스만 중단됩니다. 오프보딩 스크립트처럼 온보딩 정보를 레지스트리에서 삭제하지 않습니다.

권한

사용 권한이 가장 적은 역할을 사용하는 것이 좋습니다. 이렇게 하면 조직의 보안을 개선하는 데 도움이 됩니다. 전역 관리자는 기존 역할을 사용할 수 없는 경우 긴급 시나리오로 제한해야 하는 매우 권한이 높은 역할입니다.

사용자 자격 증명을 사용하여 토큰을 가져오는 경우:

이 API를 호출하려면 다음 권한 중 하나가 필요합니다. 사용 권한을 선택하는 방법을 포함하여 자세한 내용은 엔드포인트용 Defender API 사용을 참조하세요.

사용 권한 유형 사용 권한 사용 권한 표시 이름
응용 프로그램 Machine.Offboard Offboard machine
위임됨(회사 또는 학교 계정) Machine.Offboard Offboard machine

HTTP 요청

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

디바이스를 선택하면 URL에서 컴퓨터 ID를 찾을 수 있습니다. 일반적으로 URL에서 찾을 수 있는 40자리 영숫자 숫자입니다.

요청 헤더

이름 유형 설명
권한 부여 String 전달자 {token}. 필수입니다.
Content-Type 문자열 application/json. 필수입니다.

요청 본문

요청 본문에서 JSON 개체에 다음 매개 변수를 제공합니다.

매개 변수 유형 설명
Comment String 작업과 연결할 주석입니다. 필수입니다.

응답

성공하면 이 메서드는 응답 본문에 코드 및 200 - Created response을 반환 합니다.

예제

요청

다음은 요청의 예입니다. 추가된 JSON 주석이 없으면 코드 400로 오류가 발생합니다.

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