Microsoft Defender for Cloud Assessments API

Security assessment operations

OpenAPI Specification

microsoft-defender-for-cloud-assessments-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Microsoft Defender for Cloud REST Alerts Assessments API
  description: 'Azure Resource Manager REST API for Microsoft Defender for Cloud.

    Provides cloud security posture management (CSPM) and cloud workload

    protection (CWPP) - security alerts, security assessments, secure

    scores, regulatory compliance, and pricing/plans. Authentication uses

    Azure AD OAuth 2.0 bearer tokens against the management.azure.com

    endpoint with api-version query parameters.

    '
  version: '2022-01-01'
  contact:
    name: Kin Lane
    email: kin@apievangelist.com
  license:
    name: Microsoft Terms of Use
    url: https://www.microsoft.com/en-us/legal/terms-of-use
servers:
- url: https://management.azure.com
  description: Azure Resource Manager endpoint
security:
- azure_auth:
  - user_impersonation
tags:
- name: Assessments
  description: Security assessment operations
paths:
  /{resourceId}/providers/Microsoft.Security/assessments:
    get:
      tags:
      - Assessments
      summary: List security assessments for a resource scope
      operationId: assessments_list
      parameters:
      - name: resourceId
        in: path
        required: true
        schema:
          type: string
        description: Full resource scope (e.g. subscriptions/{id})
      - $ref: '#/components/parameters/apiVersion'
      responses:
        '200':
          description: OK
  /{resourceId}/providers/Microsoft.Security/assessments/{assessmentName}:
    get:
      tags:
      - Assessments
      summary: Get a security assessment
      operationId: assessments_get
      parameters:
      - name: resourceId
        in: path
        required: true
        schema:
          type: string
      - name: assessmentName
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/apiVersion'
      responses:
        '200':
          description: OK
components:
  parameters:
    apiVersion:
      name: api-version
      in: query
      required: true
      schema:
        type: string
        default: '2022-01-01'
  securitySchemes:
    azure_auth:
      type: oauth2
      description: Azure Active Directory OAuth 2.0
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: impersonate your user account