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

API Evangelist conversational phrasing for Identity.DirectoryManagement Directory.directory API

3 actions 3 updates phrasing extends openapi/azure-ad-directory-directory-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 3

$.info
$.paths['/directory'].get
$.paths['/directory'].patch

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 Directory.directory API
  version: 1.0.0
extends: openapi/azure-ad-directory-directory-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: 2
- target: $.paths['/directory'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tenant directory object
      effect: read
      questions:
      - What does the Microsoft Entra directory root expose, like administrative units and deleted items?
      - Can I expand deleted items or administrative units from the directory object?
      instructions:
      - text: Show me the directory object for our tenant.
      - text: Get the directory with {expand} expanded.
        slots:
          expand: query.$expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the tenant directory object
      effect: write
      questions:
      - Can I change directory-level settings such as on-premises synchronization in one patch?
      - Which directory properties, like federation configurations, can be updated?
      instructions:
      - text: Update the directory's on-premises synchronization to {onPremisesSynchronization}.
        slots:
          onPremisesSynchronization: requestBody.onPremisesSynchronization
      - text: Patch the directory with federation configurations {federationConfigurations}.
        slots:
          federationConfigurations: requestBody.federationConfigurations
      method: generated
      generated: '2026-10-01'