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

API Evangelist conversational phrasing for Identity.SignIns Identity.authentication Event Listener API

7 actions 7 updates phrasing extends openapi/azure-ad-identity-authenticationeventlistener-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['/identity/authenticationEventListeners'].get
$.paths['/identity/authenticationEventListeners'].post
$.paths['/identity/authenticationEventListeners/{authenticationEventListener-id}'].get
$.paths['/identity/authenticationEventListeners/{authenticationEventListener-id}'].delete
$.paths['/identity/authenticationEventListeners/{authenticationEventListener-id}'].patch
$.paths['/identity/authenticationEventListeners/$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 Identity.authentication Event Listener API
  version: 1.0.0
extends: openapi/azure-ad-identity-authenticationeventlistener-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['/identity/authenticationEventListeners'].get
  update:
    x-apievangelist-phrasing:
      intent: List authentication event listeners
      effect: read
      questions:
      - Which authentication event listeners are configured in my tenant?
      - Can I see every listener that hooks into sign-up or token issuance events?
      instructions:
      - text: List all authentication event listeners.
      - text: Show the first {top} authentication event listeners.
        slots:
          top: query.$top
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventListeners'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an authentication event listener
      effect: write
      questions:
      - How do I create a listener that triggers on an authentication event?
      - Can a new listener be tied to a specific authentication events flow?
      instructions:
      - text: Create an authentication event listener named {name}.
        slots:
          name: requestBody.displayName
      - text: Create a listener {name} bound to authentication events flow {flow}.
        slots:
          name: requestBody.displayName
          flow: requestBody.authenticationEventsFlowId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventListeners/{authenticationEventListener-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an authentication event listener
      effect: read
      questions:
      - What are the properties and conditions of one authentication event listener?
      - Which listener subtype is a given listener, based on its @odata.type?
      instructions:
      - text: Get authentication event listener {listener}.
        slots:
          listener: path.authenticationEventListener-id
      - text: Show the conditions and type of listener {listener}.
        slots:
          listener: path.authenticationEventListener-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventListeners/{authenticationEventListener-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an authentication event listener
      effect: destructive
      questions:
      - Can I remove an authentication event listener I no longer use?
      - What happens to the event trigger when its listener is deleted?
      instructions:
      - text: Delete authentication event listener {listener}.
        slots:
          listener: path.authenticationEventListener-id
      - text: Remove listener {listener} from the tenant.
        slots:
          listener: path.authenticationEventListener-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventListeners/{authenticationEventListener-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an authentication event listener
      effect: write
      questions:
      - Can I change the conditions or name of an existing authentication event listener?
      - What must I include, like the @odata.type, when editing a listener?
      instructions:
      - text: Rename authentication event listener {listener} to {name}.
        slots:
          listener: path.authenticationEventListener-id
          name: requestBody.displayName
      - text: Update the conditions of listener {listener} to {conditions}.
        slots:
          listener: path.authenticationEventListener-id
          conditions: requestBody.conditions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventListeners/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count authentication event listeners
      effect: read
      questions:
      - How many authentication event listeners are set up?
      - What is the total of event listeners in my tenant?
      instructions:
      - text: Count the authentication event listeners.
      - text: Tell me how many event listeners exist.
      method: generated
      generated: '2026-10-01'