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

API Evangelist conversational phrasing for Identity.SignIns Invitations.directory Object API

4 actions 4 updates phrasing extends openapi/azure-ad-invitations-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['/invitations/invitedUserSponsors'].get

$.paths['/invitations/invitedUserSponsors/{directoryObject-id}'].get

$.paths['/invitations/invitedUserSponsors/$count'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity.SignIns Invitations.directory Object API
  version: 1.0.0
extends: openapi/azure-ad-invitations-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['/invitations/invitedUserSponsors'].get
  update:
    x-apievangelist-phrasing:
      intent: List sponsors of invited guest users
      effect: read
      questions:
      - Which users or groups are sponsoring the guests we've invited?
      - Can I filter the list of invited-user sponsors to just groups?
      - Who is responsible for our guest users' privileges in the tenant?
      instructions:
      - text: List the sponsors of invited users.
      - text: List invited-user sponsors matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/invitations/invitedUserSponsors/{directoryObject-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one sponsor of an invited user
      effect: read
      questions:
      - How do I look up the details of a single guest sponsor by its object id?
      - What information is returned for one specific invited-user sponsor?
      instructions:
      - text: Get invited-user sponsor {directoryObject}.
        slots:
          directoryObject: path.directoryObject-id
      - text: Show the details of guest sponsor {directoryObject}.
        slots:
          directoryObject: path.directoryObject-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/invitations/invitedUserSponsors/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count invited-user sponsors
      effect: read
      questions:
      - How many sponsors are assigned to invited guest users?
      - Can I get just a count of guest sponsors that match a filter?
      instructions:
      - text: Count the invited-user sponsors.
      - text: Count the guest sponsors matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'