Microsoft Entra ID (formerly Azure AD) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity.SignIns Information Protection.threat Assessment…

13 actions 13 updates phrasing extends openapi/azure-ad-informationprotection-threatassessmentrequest-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Entra ID (formerly Azure AD)'s API. It is a proposal applied on top of the contract, not a document Microsoft Entra ID (formerly Azure AD) publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 13

$.info
$.paths['/informationProtection/threatAssessmentRequests'].get
$.paths['/informationProtection/threatAssessmentRequests'].post
$.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}'].get
$.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}'].delete
$.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}'].patch
$.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results'].get
$.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results'].post
$.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results/{threatAssessmentResult-id}'].get
$.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results/{threatAssessmentResult-id}'].delete
$.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results/{threatAssessmentResult-id}'].patch
$.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results/$count'].get
$.paths['/informationProtection/threatAssessmentRequests/$count'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity.SignIns Information Protection.threat Assessment…
  version: 1.0.0
extends: openapi/azure-ad-informationprotection-threatassessmentrequest-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 12
- target: $.paths['/informationProtection/threatAssessmentRequests'].get
  update:
    x-apievangelist-phrasing:
      intent: List threat assessment requests
      effect: read
      questions:
      - Which threat assessment requests have been submitted in our tenant?
      - Can I filter threat assessment requests to just the ones still pending?
      - How do I sort threat assessment requests by when they were created?
      instructions:
      - text: List all threat assessment requests.
      - text: List threat assessment requests matching {filter}.
        slots:
          filter: query.$filter
      - text: Show threat assessment requests ordered by {orderby}.
        slots:
          orderby: query.$orderby
      method: generated
      generated: '2026-10-01'
- target: $.paths['/informationProtection/threatAssessmentRequests'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a threat assessment request
      effect: write
      questions:
      - How do I report a suspicious email, URL or file for a threat assessment?
      - Can I submit something as spam or phishing that I think was classified wrong?
      - What categories can I use when filing a new threat assessment request?
      instructions:
      - text: Submit a new threat assessment request in category {category}.
        slots:
          category: requestBody.category
      - text: File a threat assessment for {contentType} content expecting it to be {expectedAssessment}.
        slots:
          contentType: requestBody.contentType
          expectedAssessment: requestBody.expectedAssessment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a threat assessment request
      effect: read
      questions:
      - What is the status of a threat assessment I submitted?
      - Can I see the results inline when I fetch one threat assessment request?
      instructions:
      - text: Get threat assessment request {threatAssessmentRequest}.
        slots:
          threatAssessmentRequest: path.threatAssessmentRequest-id
      - text: Show request {threatAssessmentRequest} with {expand} expanded.
        slots:
          threatAssessmentRequest: path.threatAssessmentRequest-id
          expand: query.$expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a threat assessment request
      effect: destructive
      questions:
      - Can I withdraw a threat assessment request I no longer need?
      - How do I delete an old threat assessment submission?
      instructions:
      - text: Delete threat assessment request {threatAssessmentRequest}.
        slots:
          threatAssessmentRequest: path.threatAssessmentRequest-id
      - text: Remove the threat submission {threatAssessmentRequest}.
        slots:
          threatAssessmentRequest: path.threatAssessmentRequest-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a threat assessment request
      effect: write
      questions:
      - Is it possible to change the category or expected verdict on a threat assessment I already filed?
      - How do I update the status of an existing threat assessment request?
      instructions:
      - text: Change the category of threat assessment request {threatAssessmentRequest} to {category}.
        slots:
          threatAssessmentRequest: path.threatAssessmentRequest-id
          category: requestBody.category
      - text: Set status {status} on existing threat request {threatAssessmentRequest}.
        slots:
          status: requestBody.status
          threatAssessmentRequest: path.threatAssessmentRequest-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: List results of a threat assessment
      effect: read
      questions:
      - What did the threat assessment conclude for my submission?
      - Can I list every result message returned for one threat assessment request?
      instructions:
      - text: List the results of threat assessment request {threatAssessmentRequest}.
        slots:
          threatAssessmentRequest: path.threatAssessmentRequest-id
      - text: Show the verdicts returned for threat submission {threatAssessmentRequest}.
        slots:
          threatAssessmentRequest: path.threatAssessmentRequest-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a result to a threat assessment
      effect: write
      questions:
      - How do I attach a new result message to a threat assessment request?
      - Can I record a result type and message against a threat submission?
      instructions:
      - text: Add a result of type {resultType} to threat assessment request {threatAssessmentRequest}.
        slots:
          resultType: requestBody.resultType
          threatAssessmentRequest: path.threatAssessmentRequest-id
      - text: Record result message {message} on threat submission {threatAssessmentRequest}.
        slots:
          message: requestBody.message
          threatAssessmentRequest: path.threatAssessmentRequest-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results/{threatAssessmentResult-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one threat assessment result
      effect: read
      questions:
      - How do I read one specific result from a threat assessment?
      - What message and result type does a single threat assessment result carry?
      instructions:
      - text: Get result {threatAssessmentResult} of threat assessment request {threatAssessmentRequest}.
        slots:
          threatAssessmentResult: path.threatAssessmentResult-id
          threatAssessmentRequest: path.threatAssessmentRequest-id
      - text: Show threat result {threatAssessmentResult} from submission {threatAssessmentRequest}.
        slots:
          threatAssessmentResult: path.threatAssessmentResult-id
          threatAssessmentRequest: path.threatAssessmentRequest-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results/{threatAssessmentResult-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a threat assessment result
      effect: destructive
      questions:
      - Can I remove a single result from a threat assessment request?
      - How do I delete one threat assessment result without deleting the whole request?
      instructions:
      - text: Delete result {threatAssessmentResult} from threat assessment request {threatAssessmentRequest}.
        slots:
          threatAssessmentResult: path.threatAssessmentResult-id
          threatAssessmentRequest: path.threatAssessmentRequest-id
      - text: Remove threat result {threatAssessmentResult} on submission {threatAssessmentRequest}.
        slots:
          threatAssessmentResult: path.threatAssessmentResult-id
          threatAssessmentRequest: path.threatAssessmentRequest-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results/{threatAssessmentResult-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a threat assessment result
      effect: write
      questions:
      - How do I change the message on an existing threat assessment result?
      - Can I correct the result type recorded on a threat assessment result?
      instructions:
      - text: Change the message of threat result {threatAssessmentResult} on request {threatAssessmentRequest} to {message}.
        slots:
          threatAssessmentResult: path.threatAssessmentResult-id
          threatAssessmentRequest: path.threatAssessmentRequest-id
          message: requestBody.message
      - text: Set result type {resultType} on existing result {threatAssessmentResult} of request {threatAssessmentRequest}.
        slots:
          resultType: requestBody.resultType
          threatAssessmentResult: path.threatAssessmentResult-id
          threatAssessmentRequest: path.threatAssessmentRequest-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/informationProtection/threatAssessmentRequests/{threatAssessmentRequest-id}/results/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count results for a threat assessment
      effect: read
      questions:
      - How many results came back for one threat assessment request?
      - Is there a way to count only the results of a submission that match a filter?
      instructions:
      - text: Count the results of threat assessment request {threatAssessmentRequest}.
        slots:
          threatAssessmentRequest: path.threatAssessmentRequest-id
      - text: Count results on submission {threatAssessmentRequest} matching {filter}.
        slots:
          threatAssessmentRequest: path.threatAssessmentRequest-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/informationProtection/threatAssessmentRequests/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count threat assessment requests
      effect: read
      questions:
      - How many threat assessment requests have we submitted in total?
      - What's the number of threat assessment requests that match a given filter?
      instructions:
      - text: Count all threat assessment requests.
      - text: Count threat assessment requests matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'