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

API Evangelist conversational phrasing for Identity.DirectoryManagement Organization.organization API

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

$.info
$.paths['/organization'].get
$.paths['/organization'].post
$.paths['/organization/{organization-id}'].get
$.paths['/organization/{organization-id}'].delete
$.paths['/organization/{organization-id}'].patch
$.paths['/organization/$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 Organization.organization API
  version: 1.0.0
extends: openapi/azure-ad-organization-organization-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: 6
- target: $.paths['/organization'].get
  update:
    x-apievangelist-phrasing:
      intent: List the tenant's organization
      effect: read
      questions:
      - What organization details are on record for my Microsoft Entra tenant?
      - Can I see my tenant's verified domains and assigned plans?
      instructions:
      - text: List the organization for this tenant.
      - text: Show my organization's name, verified domains and plans.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an organization entity
      effect: write
      questions:
      - Is there an endpoint to add a new organization entity?
      - Can I post a new organization record with a display name and country?
      instructions:
      - text: Create an organization named {name}.
        slots:
          name: requestBody.displayName
      - text: Add an organization called {name} in country {country}.
        slots:
          name: requestBody.displayName
          country: requestBody.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization/{organization-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the organization's properties
      effect: read
      questions:
      - What address, phone and technical contacts does my organization have on file?
      - Is on-premises directory sync enabled for our organization?
      instructions:
      - text: Get organization {org_id}.
        slots:
          org_id: path.organization-id
      - text: Show the contact details and sync status of organization {org_id}.
        slots:
          org_id: path.organization-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization/{organization-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization entity
      effect: destructive
      questions:
      - Can the organization entity be deleted through this endpoint?
      - What does removing an organization record do?
      instructions:
      - text: Delete organization {org_id}.
        slots:
          org_id: path.organization-id
      - text: Remove the organization entity {org_id}.
        slots:
          org_id: path.organization-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization/{organization-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the organization's settings
      effect: write
      questions:
      - How do I change who gets technical notification emails for my tenant?
      - Can I update the organization's marketing notification addresses or privacy profile?
      instructions:
      - text: Set the technical notification emails of organization {org_id} to {emails}.
        slots:
          org_id: path.organization-id
          emails: requestBody.technicalNotificationMails
      - text: Update the privacy profile of organization {org_id} to {profile}.
        slots:
          org_id: path.organization-id
          profile: requestBody.privacyProfile
      - text: Change the marketing notification emails for organization {org_id} to {emails}.
        slots:
          org_id: path.organization-id
          emails: requestBody.marketingNotificationEmails
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count organization entities
      effect: read
      questions:
      - How many organization objects does the tenant return?
      - What's the organization count for my directory?
      instructions:
      - text: Count the organization entities.
      - text: Tell me how many organizations are in the collection.
      method: generated
      generated: '2026-10-01'