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

API Evangelist conversational phrasing for Identity.DirectoryManagement Domains.directory Object API

4 actions 4 updates phrasing extends openapi/azure-ad-domains-directoryobject-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}/domainNameReferences'].get
$.paths['/domains/{domain-id}/domainNameReferences/{directoryObject-id}'].get
$.paths['/domains/{domain-id}/domainNameReferences/$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.directory Object API
  version: 1.0.0
extends: openapi/azure-ad-domains-directoryobject-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}/domainNameReferences'].get
  update:
    x-apievangelist-phrasing:
      intent: List objects that reference a domain
      effect: read
      questions:
      - Which users and groups are still using a domain I want to remove?
      - What's blocking me from deleting a domain from my tenant?
      instructions:
      - text: List the directory objects that reference domain {domain}.
        slots:
          domain: path.domain-id
      - text: Show every user and group still using domain {domain}.
        slots:
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/domainNameReferences/{directoryObject-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one object that references a domain
      effect: read
      questions:
      - Does a particular user still reference a given domain?
      - Can I read a single object from a domain's references?
      instructions:
      - text: Get object {object_id} from the references of domain {domain}.
        slots:
          object_id: path.directoryObject-id
          domain: path.domain-id
      - text: Check how directory object {object_id} uses domain {domain}.
        slots:
          object_id: path.directoryObject-id
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/domainNameReferences/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count objects that reference a domain
      effect: read
      questions:
      - How many objects still reference a domain?
      - Is a domain completely unused yet?
      instructions:
      - text: Count the objects that reference domain {domain}.
        slots:
          domain: path.domain-id
      - text: Tell me how many users and groups still use domain {domain}.
        slots:
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'