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

API Evangelist conversational phrasing for Identity.SignIns Invitations.user API

6 actions 6 updates phrasing extends openapi/azure-ad-invitations-user-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['/invitations/invitedUser'].get
$.paths['/invitations/invitedUser/mailboxSettings'].get
$.paths['/invitations/invitedUser/mailboxSettings'].patch
$.paths['/invitations/invitedUser/serviceProvisioningErrors'].get
$.paths['/invitations/invitedUser/serviceProvisioningErrors/$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.SignIns Invitations.user API
  version: 1.0.0
extends: openapi/azure-ad-invitations-user-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['/invitations/invitedUser'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the user created by an invitation
      effect: read
      questions:
      - Which user was created when an invitation was sent?
      - Can I read the invited guest's user record from the invitation?
      instructions:
      - text: Get the invited user from the invitation.
      - text: Show the guest user record the invitation created.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/invitations/invitedUser/mailboxSettings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the invited user's mailbox settings
      effect: read
      questions:
      - What mailbox settings does the invited user have?
      - Can I see the invited guest's time zone and automatic replies?
      instructions:
      - text: Get mailbox settings for the invited user.
      - text: Show the invited guest's automatic reply and working hours settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/invitations/invitedUser/mailboxSettings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the invited user's mailbox settings
      effect: write
      questions:
      - How do I change the invited user's mailbox time zone?
      - Can I turn on automatic replies for the invited guest?
      instructions:
      - text: Set the invited user's mailbox time zone to {tz}.
        slots:
          tz: requestBody.timeZone
      - text: Update the invited guest's automatic replies to {auto_reply}.
        slots:
          auto_reply: requestBody.automaticRepliesSetting
      method: generated
      generated: '2026-10-01'
- target: $.paths['/invitations/invitedUser/serviceProvisioningErrors'].get
  update:
    x-apievangelist-phrasing:
      intent: List the invited user's provisioning errors
      effect: read
      questions:
      - What provisioning errors has a federated service reported for the invited user?
      - Can I filter the invited user's service provisioning errors?
      instructions:
      - text: List service provisioning errors for the invited user.
      - text: Show invited user provisioning errors matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/invitations/invitedUser/serviceProvisioningErrors/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count the invited user's provisioning errors
      effect: read
      questions:
      - How many service provisioning errors does the invited user have?
      - Can I count the invited guest's provisioning errors matching a filter?
      instructions:
      - text: Count provisioning errors on the invited user.
      - text: Count invited user provisioning errors matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'