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

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

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

$.info
$.paths['/domains'].get
$.paths['/domains'].post
$.paths['/domains/{domain-id}'].get
$.paths['/domains/{domain-id}'].delete
$.paths['/domains/{domain-id}'].patch
$.paths['/domains/{domain-id}/rootDomain'].get
$.paths['/domains/$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.DirectoryManagement Domains.domain API
  version: 1.0.0
extends: openapi/azure-ad-domains-domain-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: 7
- target: $.paths['/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List domains in the tenant
      effect: read
      questions:
      - Which domains are associated with my Microsoft Entra tenant?
      - Can I filter my domains to see only verified ones?
      instructions:
      - text: List all domains in the tenant.
      - text: Show domains matching {filter}, ordered by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a domain to the tenant
      effect: write
      questions:
      - How do I add my company's custom domain to the tenant?
      - Can I use a newly added domain before its ownership is verified?
      instructions:
      - text: Add domain {domain} to the tenant.
        slots:
          domain: requestBody.id
      - text: Add domain {domain} with authentication type {authType}.
        slots:
          domain: requestBody.id
          authType: requestBody.authenticationType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a domain's details
      effect: read
      questions:
      - Is a specific domain verified and set as the default?
      - What authentication type and supported services does one domain have?
      instructions:
      - text: Get domain {domain}.
        slots:
          domain: path.domain-id
      - text: Show verification status and supported services for {domain}.
        slots:
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a domain from the tenant
      effect: destructive
      questions:
      - How do I remove a custom domain from my tenant?
      - Can I delete a domain we stopped using?
      instructions:
      - text: Delete domain {domain} from the tenant.
        slots:
          domain: path.domain-id
      - text: Remove the custom domain {domain}.
        slots:
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a verified domain
      effect: write
      questions:
      - How do I make a verified domain the default for new users?
      - Can I change password expiry settings on a domain that isn't verified yet?
      instructions:
      - text: Make domain {domain} the default by setting isDefault to {isDefault}.
        slots:
          domain: path.domain-id
          isDefault: requestBody.isDefault
      - text: Set password validity on {domain} to {days} days.
        slots:
          domain: path.domain-id
          days: requestBody.passwordValidityPeriodInDays
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/rootDomain'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the root domain of a subdomain
      effect: read
      questions:
      - Which root domain does a subdomain in my tenant belong to?
      - What is the parent domain of one of my subdomains?
      instructions:
      - text: Get the root domain of subdomain {domain}.
        slots:
          domain: path.domain-id
      - text: Show the parent root domain for {domain}.
        slots:
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count domains in the tenant
      effect: read
      questions:
      - How many domains does my tenant have?
      - What is the number of domains matching a condition?
      instructions:
      - text: Count the domains in the tenant.
      - text: Give me the number of domains matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'