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

API Evangelist conversational phrasing for Identity.DirectoryManagement Domains.domain.Actions API

4 actions 4 updates phrasing extends openapi/azure-ad-domains-domain-actions-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 4

$.info
$.paths['/domains/{domain-id}/microsoft.graph.forceDelete'].post
$.paths['/domains/{domain-id}/microsoft.graph.promote'].post
$.paths['/domains/{domain-id}/microsoft.graph.verify'].post

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.DirectoryManagement Domains.domain.Actions API
  version: 1.0.0
extends: openapi/azure-ad-domains-domain-actions-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: 3
- target: $.paths['/domains/{domain-id}/microsoft.graph.forceDelete'].post
  update:
    x-apievangelist-phrasing:
      intent: Force delete a domain
      effect: destructive
      questions:
      - How do I force delete a custom domain that still has users and groups referencing it?
      - Can I disable the user accounts tied to a domain when I force delete it?
      instructions:
      - text: Force delete domain {domain}.
        slots:
          domain: path.domain-id
      - text: 'Force delete domain {domain} and disable affected user accounts: {disableUserAccounts}.'
        slots:
          domain: path.domain-id
          disableUserAccounts: requestBody.disableUserAccounts
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/microsoft.graph.promote'].post
  update:
    x-apievangelist-phrasing:
      intent: Promote a subdomain to root domain
      effect: write
      questions:
      - How do I promote a verified subdomain to be a root domain in my tenant?
      - Does a subdomain need to be verified before I can promote it?
      instructions:
      - text: Promote subdomain {domain} to a root domain.
        slots:
          domain: path.domain-id
      - text: Make verified subdomain {domain} a root domain.
        slots:
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/microsoft.graph.verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify domain ownership
      effect: write
      questions:
      - How do I verify that I own a custom domain I added to Entra ID?
      - Can I re-run verification on a domain that's already verified?
      instructions:
      - text: Verify ownership of domain {domain}.
        slots:
          domain: path.domain-id
      - text: Run the domain verification check for {domain} now that the DNS record is in place.
        slots:
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'