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

API Evangelist conversational phrasing for Identity.DirectoryManagement Contacts.org Contact API

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

$.info

$.paths['/contacts'].get

$.paths['/contacts/{orgContact-id}'].get

$.paths['/contacts/{orgContact-id}'].delete

$.paths['/contacts/{orgContact-id}'].patch

$.paths['/contacts/$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.DirectoryManagement Contacts.org Contact API
  version: 1.0.0
extends: openapi/azure-ad-contacts-orgcontact-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: 5
- target: $.paths['/contacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizational contacts
      effect: read
      questions:
      - Which external contacts are in our organization's directory?
      - Can I list organizational contacts filtered by company or name?
      instructions:
      - text: List all organizational contacts.
      - text: Show organizational contacts matching the filter {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/{orgContact-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organizational contact
      effect: read
      questions:
      - How do I look up an external contact's email, phones and company?
      - What properties does a single organizational contact have?
      instructions:
      - text: Get organizational contact {contact}.
        slots:
          contact: path.orgContact-id
      - text: Show the email and job title of contact {contact}.
        slots:
          contact: path.orgContact-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/{orgContact-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organizational contact
      effect: destructive
      questions:
      - How do I remove an external contact from our directory?
      - Can I delete an org contact only if it hasn't changed since I read it?
      instructions:
      - text: Delete organizational contact {contact}.
        slots:
          contact: path.orgContact-id
      - text: Remove contact {contact} if its ETag is {etag}.
        slots:
          contact: path.orgContact-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/{orgContact-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an organizational contact
      effect: write
      questions:
      - How do I change an external contact's job title or department?
      - Can I update the phone numbers stored on an org contact?
      instructions:
      - text: Set the job title of contact {contact} to {jobTitle}.
        slots:
          contact: path.orgContact-id
          jobTitle: requestBody.jobTitle
      - text: Change the company name of org contact {contact} to {company}.
        slots:
          contact: path.orgContact-id
          company: requestBody.companyName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/contacts/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count organizational contacts
      effect: read
      questions:
      - How many organizational contacts do we have?
      - What's the total count of external contacts in the directory?
      instructions:
      - text: Count the organizational contacts.
      - text: Tell me how many external contacts our tenant holds.
      method: generated
      generated: '2026-10-01'