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

API Evangelist conversational phrasing for Microsoft Graph API (Azure AD) Groups API

4 actions 4 updates phrasing extends openapi/azure-ad-groups-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['/groups'].get
$.paths['/groups'].post
$.paths['/groups/{id}'].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 Microsoft Graph API (Azure AD) Groups API
  version: 1.0.0
extends: openapi/azure-ad-groups-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['/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups in the organization
      effect: read
      questions:
      - How do I list all the groups in my Entra ID tenant?
      - Can I get every security and Microsoft 365 group in one listing?
      - Why don't dynamic distribution groups show up when I list groups?
      instructions:
      - text: List all groups in the organization.
      - text: Show me every group in my tenant, security and Microsoft 365 alike.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a group
      effect: write
      questions:
      - How do I create a new security group in Entra ID?
      - What do I need to set to create a mail-enabled Microsoft 365 group?
      instructions:
      - text: Create a security group called {displayName} with security enabled set to {securityEnabled}.
        slots:
          displayName: requestBody.displayName
          securityEnabled: requestBody.securityEnabled
      - text: Create a new group {displayName} described as {description}.
        slots:
          displayName: requestBody.displayName
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one group's details
      effect: read
      questions:
      - How can I look up a single group by its ID?
      - What properties does a specific group have?
      instructions:
      - text: Fetch group {id}.
        slots:
          id: path.id
      - text: Show the details of the group with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'