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

API Evangelist conversational phrasing for Identity.SignIns Identity.authentication Events Flow API

40 actions 40 updates phrasing extends openapi/azure-ad-identity-authenticationeventsflow-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 40 · first 16 shown; the file carries all of them

$.info
$.paths['/identity/authenticationEventsFlows'].get
$.paths['/identity/authenticationEventsFlows'].post
$.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}'].get
$.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}'].delete
$.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}'].patch
$.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions'].get
$.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications'].get
$.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications'].post
$.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/{authenticationConditionApplication-appId}'].get
$.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/{authenticationConditionApplication-appId}'].delete
$.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/{authenticationConditionApplication-appId}'].patch
$.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/$count'].get
$.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow'].get
$.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions'].get
$.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications'].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 Events Flow API
  version: 1.0.0
extends: openapi/azure-ad-identity-authenticationeventsflow-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: 39
- target: $.paths['/identity/authenticationEventsFlows'].get
  update:
    x-apievangelist-phrasing:
      intent: List authentication events flows (user flows)
      effect: read
      questions:
      - How do I see all the sign-up user flows configured in my Entra External ID tenant?
      - Which authentication events policies exist in my tenant right now?
      - Can I filter the list of authentication event flows by display name?
      instructions:
      - text: List every authentication events flow in the tenant.
      - text: Show authentication events flows matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an authentication events flow
      effect: write
      questions:
      - How do I create a new self-service sign-up user flow for external users?
      - What do I have to send to set up a new authentication events policy?
      instructions:
      - text: Create a new authentication events flow called {displayName}.
        slots:
          displayName: requestBody.displayName
      - text: Set up a sign-up user flow named {displayName} described as {description}.
        slots:
          displayName: requestBody.displayName
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one authentication events flow
      effect: read
      questions:
      - How can I look up the full settings of one specific user flow by its ID?
      - What subtype is a given authentication events flow, and what does it contain?
      instructions:
      - text: Get authentication events flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Show me the configuration of user flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an authentication events flow
      effect: destructive
      questions:
      - What happens to linked applications when I delete a user flow?
      - Can I remove a sign-up user flow I no longer need?
      instructions:
      - text: Delete authentication events flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Remove user flow {flow} and unlink all its applications.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an authentication events flow
      effect: write
      questions:
      - How do I rename an existing user flow or change its description?
      - Can I change the conditions on a user flow after it's created?
      instructions:
      - text: Rename authentication events flow {flow} to {displayName}.
        slots:
          flow: path.authenticationEventsFlow-id
          displayName: requestBody.displayName
      - text: Change the description of user flow {flow} to {description}.
        slots:
          flow: path.authenticationEventsFlow-id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the conditions that trigger a user flow
      effect: read
      questions:
      - What conditions decide whether a particular user flow gets invoked?
      - Which authentication request context causes an events policy to run?
      instructions:
      - text: Show the invocation conditions for authentication events flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Tell me when user flow {flow} gets triggered.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications'].get
  update:
    x-apievangelist-phrasing:
      intent: List applications linked to a user flow
      effect: read
      questions:
      - Which apps are currently linked to my self-service sign-up user flow?
      - How can I see what applications use a given authentication events flow?
      instructions:
      - text: List the applications linked to user flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Which apps use sign-up flow {flow}? List them.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications'].post
  update:
    x-apievangelist-phrasing:
      intent: Link an application to a user flow
      effect: write
      questions:
      - How do I enable a sign-up user flow for one of my applications?
      - Can I attach an app to an existing authentication events flow by its app ID?
      instructions:
      - text: Link application {appId} to user flow {flow}.
        slots:
          appId: requestBody.appId
          flow: path.authenticationEventsFlow-id
      - text: Enable the sign-up experience of flow {flow} for app {appId}.
        slots:
          flow: path.authenticationEventsFlow-id
          appId: requestBody.appId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/{authenticationConditionApplication-appId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one application linked to a user flow
      effect: read
      questions:
      - Is a specific app included in the conditions of a given user flow?
      - How do I read a single linked application entry on an authentication events flow?
      instructions:
      - text: Get linked application {appId} on user flow {flow}.
        slots:
          appId: path.authenticationConditionApplication-appId
          flow: path.authenticationEventsFlow-id
      - text: Check whether app {appId} is included in flow {flow}.
        slots:
          appId: path.authenticationConditionApplication-appId
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/{authenticationConditionApplication-appId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink an application from a user flow
      effect: destructive
      questions:
      - How do I stop an app from using a customized sign-up user flow?
      - Can I remove one application from an authentication events flow without deleting the flow?
      instructions:
      - text: Unlink application {appId} from user flow {flow}.
        slots:
          appId: path.authenticationConditionApplication-appId
          flow: path.authenticationEventsFlow-id
      - text: Stop app {appId} from using the custom sign-up experience of flow {flow}.
        slots:
          appId: path.authenticationConditionApplication-appId
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/{authenticationConditionApplication-appId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an application link on a user flow
      effect: write
      questions:
      - Can I edit the linked-application entry on a user flow's conditions?
      - How do I change which app ID an included application entry points to?
      instructions:
      - text: Update linked application {appId} on user flow {flow}.
        slots:
          appId: path.authenticationConditionApplication-appId
          flow: path.authenticationEventsFlow-id
      - text: Edit the included-application entry {appId} in the conditions of flow {flow}.
        slots:
          appId: path.authenticationConditionApplication-appId
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/conditions/applications/includeApplications/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count applications linked to a user flow
      effect: read
      questions:
      - How many applications are linked to a particular user flow?
      - What's the number of included apps on an authentication events flow?
      instructions:
      - text: Count the applications linked to user flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Tell me how many apps are included in flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a flow cast as a self-service sign-up flow
      effect: read
      questions:
      - How do I read a flow specifically as an external users self-service sign-up flow type?
      - Can I fetch one authentication events flow typed as externalUsersSelfServiceSignUpEventsFlow?
      instructions:
      - text: Get flow {flow} cast as an external users self-service sign-up flow.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Read flow {flow} as the externalUsersSelfServiceSignUpEventsFlow type.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get conditions of a self-service sign-up flow
      effect: read
      questions:
      - What invocation conditions are set on a self-service sign-up flow, read through its typed path?
      - Which conditions are stored on the externalUsersSelfServiceSignUpEventsFlow cast of a flow?
      instructions:
      - text: Show the conditions of flow {flow} through the self-service sign-up cast.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Read the externalUsersSelfServiceSignUpEventsFlow conditions of flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications'].get
  update:
    x-apievangelist-phrasing:
      intent: List apps on a self-service sign-up flow (typed)
      effect: read
      questions:
      - Which applications are linked to a flow when I read it as a self-service sign-up flow?
      - How do I list included apps via the externalUsersSelfServiceSignUpEventsFlow path?
      instructions:
      - text: List apps linked to self-service sign-up flow {flow} using the typed cast.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Read the included apps of flow {flow} as an externalUsersSelfServiceSignUpEventsFlow.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications'].post
  update:
    x-apievangelist-phrasing:
      intent: Link an app via the self-service sign-up cast
      effect: write
      questions:
      - Can I add an included application through the self-service sign-up flow's typed path?
      - How do I attach an app to an externalUsersSelfServiceSignUpEventsFlow directly?
      instructions:
      - text: Add app {appId} to self-service sign-up flow {flow} through the typed cast.
        slots:
          appId: requestBody.appId
          flow: path.authenticationEventsFlow-id
      - text: Via the externalUsersSelfServiceSignUpEventsFlow path, include app {appId} in flow {flow}.
        slots:
          appId: requestBody.appId
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/{authenticationConditionApplication-appId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a linked app on a self-service sign-up flow
      effect: read
      questions:
      - How do I read one included app entry on the self-service sign-up cast of a flow?
      - Is a given app ID in the typed self-service sign-up flow's application conditions?
      instructions:
      - text: Get app {appId} from self-service sign-up flow {flow} via the typed cast.
        slots:
          appId: path.authenticationConditionApplication-appId
          flow: path.authenticationEventsFlow-id
      - text: Via the externalUsersSelfServiceSignUpEventsFlow path, read included app {appId} of flow {flow}.
        slots:
          appId: path.authenticationConditionApplication-appId
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/{authenticationConditionApplication-appId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink an app via the self-service sign-up cast
      effect: destructive
      questions:
      - Can I remove an included app through the externalUsersSelfServiceSignUpEventsFlow path?
      - How do I drop one app from a self-service sign-up flow using its typed endpoint?
      instructions:
      - text: Remove app {appId} from self-service sign-up flow {flow} through the typed cast.
        slots:
          appId: path.authenticationConditionApplication-appId
          flow: path.authenticationEventsFlow-id
      - text: Via the externalUsersSelfServiceSignUpEventsFlow path, unlink app {appId} from flow {flow}.
        slots:
          appId: path.authenticationConditionApplication-appId
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/{authenticationConditionApplication-appId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an app link via the self-service sign-up cast
      effect: write
      questions:
      - How do I edit an included app entry on the typed self-service sign-up flow?
      - Can I patch a linked application through the externalUsersSelfServiceSignUpEventsFlow path?
      instructions:
      - text: Update included app {appId} on self-service sign-up flow {flow} via the typed cast.
        slots:
          appId: path.authenticationConditionApplication-appId
          flow: path.authenticationEventsFlow-id
      - text: Via the externalUsersSelfServiceSignUpEventsFlow path, patch included app {appId} of flow {flow}.
        slots:
          appId: path.authenticationConditionApplication-appId
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count apps on a self-service sign-up flow (typed)
      effect: read
      questions:
      - How many apps are linked when I count through the self-service sign-up cast?
      - What's the included-application count on an externalUsersSelfServiceSignUpEventsFlow?
      instructions:
      - text: Give me the included-app total for self-service sign-up flow {flow}, read through the typed cast.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Via the externalUsersSelfServiceSignUpEventsFlow path, count included apps on flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sign-up flow's attribute collection handler
      effect: read
      questions:
      - What runs when a sign-up flow is ready to collect attributes from the user?
      - How do I see the onAttributeCollection configuration of a self-service sign-up flow?
      instructions:
      - text: Show the attribute collection handler for sign-up flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: What does sign-up flow {flow} invoke when collecting user attributes? Show it.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the attribute collection handler as sign-up type
      effect: read
      questions:
      - Can I read a flow's attribute collection handler cast to the external users self-service sign-up handler type?
      - How do I get onAttributeCollectionExternalUsersSelfServiceSignUp for a user flow?
      instructions:
      - text: Get the attribute collection handler of flow {flow} cast to the self-service sign-up handler type.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Read onAttributeCollectionExternalUsersSelfServiceSignUp for flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: List the attributes a sign-up flow collects
      effect: read
      questions:
      - Which user attributes does my sign-up user flow ask people for?
      - How do I see the full attribute objects collected during self-service sign-up?
      instructions:
      - text: List the attributes collected by sign-up flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Show which fields sign-up flow {flow} asks new users to fill in.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/{identityUserFlowAttribute-id}/$ref'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an attribute from a sign-up flow by ID
      effect: destructive
      questions:
      - How do I stop collecting a specific attribute in my sign-up flow when I know its attribute ID?
      - Can I unlink one user flow attribute from a sign-up flow using the attribute's ID in the path?
      instructions:
      - text: Remove attribute {attribute} from sign-up flow {flow}.
        slots:
          attribute: path.identityUserFlowAttribute-id
          flow: path.authenticationEventsFlow-id
      - text: Stop sign-up flow {flow} from collecting attribute {attribute}.
        slots:
          flow: path.authenticationEventsFlow-id
          attribute: path.identityUserFlowAttribute-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count the attributes a sign-up flow collects
      effect: read
      questions:
      - How many attributes does a given sign-up user flow collect?
      - What's the number of collected attributes configured on a self-service sign-up flow?
      instructions:
      - text: Count the attributes collected by sign-up flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Tell me how many fields sign-up flow {flow} collects.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref'].get
  update:
    x-apievangelist-phrasing:
      intent: List attribute references on a sign-up flow
      effect: read
      questions:
      - Can I get just the reference links of the attributes a sign-up flow collects?
      - How do I list attribute $ref entries rather than full attribute objects for a user flow?
      instructions:
      - text: List the attribute references on sign-up flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Return only the attribute $ref links for sign-up flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an attribute to a sign-up flow
      effect: write
      questions:
      - How do I start collecting a new attribute like city or job title during sign-up?
      - Can I add a custom user flow attribute to an existing self-service sign-up flow?
      instructions:
      - text: Add attribute {attributeRef} to sign-up flow {flow}.
        slots:
          attributeRef: requestBody.@odata.id
          flow: path.authenticationEventsFlow-id
      - text: Start collecting attribute {attributeRef} when users sign up through flow {flow}.
        slots:
          attributeRef: requestBody.@odata.id
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/$ref'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an attribute from a sign-up flow by reference
      effect: destructive
      questions:
      - How do I remove a collected attribute using its @id reference URL instead of its ID?
      - Can I unlink an attribute from a sign-up flow by passing the attribute reference as a query value?
      instructions:
      - text: Remove the attribute referenced by {ref} from sign-up flow {flow}.
        slots:
          ref: query.@id
          flow: path.authenticationEventsFlow-id
      - text: Unlink the attribute whose @id is {ref} from flow {flow}.
        slots:
          ref: query.@id
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sign-up flow's authentication method load handler
      effect: read
      questions:
      - What happens when a sign-up flow is ready to present authentication methods to the user?
      - How do I read the onAuthenticationMethodLoadStart configuration of a user flow?
      instructions:
      - text: Show the authentication method load handler for sign-up flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: What does sign-up flow {flow} invoke before showing sign-in methods? Show it.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the method load handler as sign-up type
      effect: read
      questions:
      - Can I read a flow's authentication method load handler cast to its self-service sign-up handler type?
      - How do I get onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp for a flow?
      instructions:
      - text: Get the method load handler of flow {flow} cast to the self-service sign-up handler type.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Read onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp for flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity providers in a sign-up flow
      effect: read
      questions:
      - Which identity providers, like email or social accounts, can people sign up with in my user flow?
      - How do I see the full identity provider objects defined for a self-service sign-up flow?
      instructions:
      - text: List the identity providers offered in sign-up flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Show which sign-in options people get in sign-up flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/{identityProviderBase-id}/$ref'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an identity provider from a sign-up flow by ID
      effect: destructive
      questions:
      - How do I take a sign-in option out of my user flow when I know the provider's ID?
      - Can I unlink an identity provider from a sign-up flow using its ID in the path?
      instructions:
      - text: Remove identity provider {provider} from sign-up flow {flow}.
        slots:
          provider: path.identityProviderBase-id
          flow: path.authenticationEventsFlow-id
      - text: Take sign-in option {provider} out of sign-up flow {flow}.
        slots:
          provider: path.identityProviderBase-id
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count identity providers in a sign-up flow
      effect: read
      questions:
      - How many identity providers are enabled on a given sign-up user flow?
      - What's the count of sign-in options configured for a self-service sign-up flow?
      instructions:
      - text: Count the identity providers on sign-up flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Tell me how many sign-in options sign-up flow {flow} offers.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$ref'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity provider references on a sign-up flow
      effect: read
      questions:
      - Can I get only the reference links of the identity providers in a sign-up flow?
      - How do I list identity provider $ref entries instead of full objects for a user flow?
      instructions:
      - text: List the identity provider references on sign-up flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      - text: Return only the identity provider $ref links for sign-up flow {flow}.
        slots:
          flow: path.authenticationEventsFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/authenticationEventsFlows/{authenticationEventsFlow-id}/microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/$ref'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an identity provider to a sign-up flow
      effect: write
      questions:
      - How do I let people sign up with a social account like Google or Facebook in my user flow?
      - Can I add another identity provider to an existing self-service sign-up flow?
      instructions:
      - text: Add identity provider {providerRef} to sign-up flow {flow}.
        slots:
          providerRef: requestBody.@odata.id
          flow: path.authenticationEventsFlow-id
      - text: Let users of sign-up flow {flow} sign in with identity provider {providerRef}.
        slots:
          flow: path.authenticationEventsFlow-id
          providerRef: requestBody.@odata.id
      method: generated
      generated: '2026-10-01'


# --- truncated at 32 KB (34 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/azure-ad/refs/heads/main/overlays/azure-ad-identity-authenticationeventsflow-api-phrasing-overlay.yaml