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

API Evangelist conversational phrasing for Identity.SignIns Identity.b2x Identity User Flow API

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

$.info
$.paths['/identity/b2xUserFlows'].get
$.paths['/identity/b2xUserFlows'].post
$.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}'].get
$.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}'].delete
$.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}'].patch
$.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration'].get
$.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection'].get
$.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection'].delete
$.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection'].patch
$.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection/$ref'].get
$.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection/$ref'].put
$.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection/$ref'].delete
$.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection/microsoft.graph.uploadClientCertificate'].post
$.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postFederationSignup'].get
$.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postFederationSignup'].delete

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.b2x Identity User Flow API
  version: 1.0.0
extends: openapi/azure-ad-identity-b2xidentityuserflow-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: 63
- target: $.paths['/identity/b2xUserFlows'].get
  update:
    x-apievangelist-phrasing:
      intent: List B2X self-service sign-up user flows
      effect: read
      questions:
      - Which self-service sign-up user flows are set up for guests in my Entra tenant?
      - Can I filter my B2X user flows by a property value?
      instructions:
      - text: List all B2X sign-up user flows in the tenant.
      - text: Show B2X user flows matching {filter}, top {top} only.
        slots:
          filter: query.$filter
          top: query.$top
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a B2X self-service sign-up user flow
      effect: write
      questions:
      - How do I create a new self-service sign-up flow for external guests?
      - Can I choose identity providers and languages when creating a B2X user flow?
      instructions:
      - text: Create a new B2X sign-up user flow with identity providers {providers}.
        slots:
          providers: requestBody.identityProviders
      - text: Create a B2X user flow collecting attributes {attributes} with API connectors {connectors}.
        slots:
          attributes: requestBody.userAttributeAssignments
          connectors: requestBody.apiConnectorConfiguration
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one B2X user flow
      effect: read
      questions:
      - What are the settings and relationships of one specific guest sign-up user flow?
      - Where can I see the full configuration of a single B2X user flow?
      instructions:
      - text: Get B2X user flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      - text: Show the properties of sign-up user flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a B2X user flow
      effect: destructive
      questions:
      - How do I remove a guest self-service sign-up flow I no longer need?
      - Can I delete a whole B2X user flow object?
      instructions:
      - text: Delete B2X user flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      - text: Remove the entire sign-up user flow {flow} from the tenant.
        slots:
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a B2X user flow
      effect: write
      questions:
      - How do I change the settings of an existing B2X sign-up user flow?
      - Can I change which identity providers an existing user flow offers in one update?
      instructions:
      - text: Update B2X user flow {flow} to use identity providers {providers}.
        slots:
          flow: path.b2xIdentityUserFlow-id
          providers: requestBody.identityProviders
      - text: Patch user flow {flow} with API connector configuration {connectors}.
        slots:
          flow: path.b2xIdentityUserFlow-id
          connectors: requestBody.apiConnectorConfiguration
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the API connectors enabled for a user flow
      effect: read
      questions:
      - Which API connectors are enabled in a B2X user flow?
      - What API connector configuration does my guest sign-up flow use?
      instructions:
      - text: Show the API connector configuration for user flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      - text: List which API connectors are enabled on sign-up flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the post-attribute-collection API connector
      effect: read
      questions:
      - What API connector runs after attributes are collected in my sign-up flow?
      - Which endpoint is called once a guest submits their sign-up attributes?
      instructions:
      - text: Get the post-attribute-collection API connector for user flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      - text: Show the connector's target URL after attribute collection in flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the post-attribute-collection connector
      effect: destructive
      questions:
      - How do I delete the API connector object that runs after attribute collection?
      - Can I remove the post-attribute-collection connector entity from a sign-up flow?
      instructions:
      - text: Delete the post-attribute-collection API connector from user flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      - text: Remove the after-attribute-collection connector entity on flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the post-attribute-collection connector
      effect: write
      questions:
      - How do I change the target URL of the connector called after attribute collection?
      - Can I rename the API connector that runs after attributes are collected?
      instructions:
      - text: Set the post-attribute-collection connector URL in flow {flow} to {url}.
        slots:
          flow: path.b2xIdentityUserFlow-id
          url: requestBody.targetUrl
      - text: Rename the after-attribute-collection connector on flow {flow} to {name}.
        slots:
          flow: path.b2xIdentityUserFlow-id
          name: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection/$ref'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the reference to the post-attribute connector
      effect: read
      questions:
      - What is the reference link to the post-attribute-collection connector in a user flow?
      - Which connector ID is linked for the post-attribute-collection step?
      instructions:
      - text: Get the $ref link for the post-attribute-collection connector of flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      - text: Show only the reference ID of the attribute-collection connector on flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection/$ref'].put
  update:
    x-apievangelist-phrasing:
      intent: Link an API connector to post-attribute collection
      effect: write
      questions:
      - How do I point the post-attribute-collection step at an existing API connector?
      - Can I swap which existing connector runs after attribute collection?
      instructions:
      - text: Link the existing API connector {connector} as post-attribute-collection for flow {flow}.
        slots:
          connector: requestBody.@odata.id
          flow: path.b2xIdentityUserFlow-id
      - text: Point the after-attribute-collection step of flow {flow} to connector {connector}.
        slots:
          flow: path.b2xIdentityUserFlow-id
          connector: requestBody.@odata.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection/$ref'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink the post-attribute-collection connector
      effect: destructive
      questions:
      - How do I unlink an API connector from the post-attribute-collection step without deleting it?
      - Can I detach the attribute-collection connector reference from a user flow?
      instructions:
      - text: Unlink the post-attribute-collection connector reference from flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      - text: Detach the attribute-collection $ref on flow {flow}, keeping the connector itself.
        slots:
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postAttributeCollection/microsoft.graph.uploadClientCertificate'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a client certificate to the attribute connector
      effect: write
      questions:
      - How do I upload a .pfx certificate for the post-attribute-collection API connector?
      - Can the attribute-collection connector authenticate with a PKCS 12 client certificate?
      instructions:
      - text: Upload PKCS 12 certificate {pfx} with password {password} to the post-attribute-collection connector of flow {flow}.
        slots:
          pfx: requestBody.pkcs12Value
          password: requestBody.password
          flow: path.b2xIdentityUserFlow-id
      - text: Add client cert {pfx} to the attribute-collection connector on flow {flow}.
        slots:
          pfx: requestBody.pkcs12Value
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postFederationSignup'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the post-federation-signup API connector
      effect: read
      questions:
      - What API connector runs after a guest signs in with a federated identity provider?
      - Which endpoint is called right after federated sign-up in my user flow?
      instructions:
      - text: Get the post-federation-signup API connector for user flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      - text: Show the connector that fires after federated sign-in on flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postFederationSignup'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the post-federation-signup connector
      effect: destructive
      questions:
      - How do I delete the API connector entity that runs after federated sign-up?
      - Can I remove the post-federation-signup connector object from a user flow?
      instructions:
      - text: Delete the post-federation-signup API connector from user flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      - text: Remove the after-federation connector entity on sign-up flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postFederationSignup'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the post-federation-signup connector
      effect: write
      questions:
      - How do I change the target URL of the connector called after federated sign-up?
      - Can I change authentication settings on the post-federation-signup connector?
      instructions:
      - text: Set the post-federation-signup connector URL in flow {flow} to {url}.
        slots:
          flow: path.b2xIdentityUserFlow-id
          url: requestBody.targetUrl
      - text: Update auth config of the after-federation connector on flow {flow} to {auth}.
        slots:
          flow: path.b2xIdentityUserFlow-id
          auth: requestBody.authenticationConfiguration
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postFederationSignup/$ref'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the reference to the post-federation connector
      effect: read
      questions:
      - What is the reference link to the post-federation-signup connector?
      - Which connector ID is linked to run after federated sign-up?
      instructions:
      - text: Get the $ref link for the post-federation-signup connector of flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      - text: Show just the reference ID of the federation-signup connector on flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postFederationSignup/$ref'].put
  update:
    x-apievangelist-phrasing:
      intent: Link an API connector to post-federation signup
      effect: write
      questions:
      - How do I point the post-federation-signup step at an existing API connector?
      - Can I change which existing connector runs after federated sign-up?
      instructions:
      - text: Link the existing API connector {connector} as post-federation-signup for flow {flow}.
        slots:
          connector: requestBody.@odata.id
          flow: path.b2xIdentityUserFlow-id
      - text: Point the after-federation step of flow {flow} to connector {connector}.
        slots:
          flow: path.b2xIdentityUserFlow-id
          connector: requestBody.@odata.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postFederationSignup/$ref'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink the post-federation-signup connector
      effect: destructive
      questions:
      - How do I unlink the connector from the post-federation-signup step without deleting it?
      - Can I detach the federation-signup connector reference from a user flow?
      instructions:
      - text: Unlink the post-federation-signup connector reference from flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      - text: Detach the federation-signup $ref on flow {flow}, keeping the connector itself.
        slots:
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/apiConnectorConfiguration/postFederationSignup/microsoft.graph.uploadClientCertificate'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a client certificate to the federation connector
      effect: write
      questions:
      - How do I upload a .pfx certificate for the post-federation-signup API connector?
      - Can the federation-signup connector use a password-protected PKCS 12 certificate?
      instructions:
      - text: Upload PKCS 12 certificate {pfx} with password {password} to the post-federation-signup connector of flow {flow}.
        slots:
          pfx: requestBody.pkcs12Value
          password: requestBody.password
          flow: path.b2xIdentityUserFlow-id
      - text: Add client cert {pfx} to the federation-signup connector on flow {flow}.
        slots:
          pfx: requestBody.pkcs12Value
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/identityProviders'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity providers in a user flow
      effect: read
      questions:
      - Which identity providers can guests sign in with in a given B2X user flow?
      - What sign-in options does my self-service sign-up flow offer?
      instructions:
      - text: List the identity providers included in user flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      - text: Show identity providers of flow {flow} matching {filter}.
        slots:
          flow: path.b2xIdentityUserFlow-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/identityProviders/{identityProvider-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one identity provider in a user flow
      effect: read
      questions:
      - What are the details of one identity provider included in a sign-up flow?
      - Is a specific identity provider part of a given B2X user flow?
      instructions:
      - text: Get identity provider {provider} from user flow {flow}.
        slots:
          provider: path.identityProvider-id
          flow: path.b2xIdentityUserFlow-id
      - text: Show the details of provider {provider} in sign-up flow {flow}.
        slots:
          provider: path.identityProvider-id
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/identityProviders/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count identity providers in a user flow
      effect: read
      questions:
      - How many identity providers are included in a B2X user flow?
      - What is the number of sign-in providers on one sign-up flow?
      instructions:
      - text: Count the identity providers in user flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      - text: Give me the number of identity providers on flow {flow} matching {filter}.
        slots:
          flow: path.b2xIdentityUserFlow-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages'].get
  update:
    x-apievangelist-phrasing:
      intent: List languages configured for a user flow
      effect: read
      questions:
      - Which languages can I customize for my B2X sign-up flow?
      - What languages are supported for localizing a guest user flow?
      instructions:
      - text: List the languages configured for user flow {flow}.
        slots:
          flow: path.b2xIdentityUserFlow-id
      - text: Show enabled languages of flow {flow} matching {filter}.
        slots:
          flow: path.b2xIdentityUserFlow-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a language to a user flow
      effect: write
      questions:
      - How do I add a new language configuration to a B2X user flow?
      - Can I add a language that starts disabled?
      instructions:
      - text: Add language {language} to user flow {flow}.
        slots:
          language: requestBody.id
          flow: path.b2xIdentityUserFlow-id
      - text: Add language {language} named {name} to flow {flow} with enabled set to {enabled}.
        slots:
          language: requestBody.id
          name: requestBody.displayName
          flow: path.b2xIdentityUserFlow-id
          enabled: requestBody.isEnabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a language configuration of a user flow
      effect: read
      questions:
      - Is a particular language enabled in my sign-up user flow?
      - What are the settings of one language configuration in a B2X flow?
      instructions:
      - text: Get language {language} of user flow {flow}.
        slots:
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      - text: Show whether language {language} is enabled on flow {flow}.
        slots:
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a language from a user flow
      effect: destructive
      questions:
      - How do I remove a language configuration from a guest sign-up flow?
      - Can I delete a language I no longer want to offer in a user flow?
      instructions:
      - text: Remove language {language} from user flow {flow}.
        slots:
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      - text: Delete the {language} language configuration on flow {flow}.
        slots:
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a language configuration
      effect: write
      questions:
      - How do I enable or disable a language in an existing user flow?
      - Can I rename a language configuration in my sign-up flow?
      instructions:
      - text: Set enabled to {enabled} for language {language} in flow {flow}.
        slots:
          enabled: requestBody.isEnabled
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      - text: Rename language {language} on flow {flow} to {name}.
        slots:
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
          name: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/defaultPages'].get
  update:
    x-apievangelist-phrasing:
      intent: List default pages for a user flow language
      effect: read
      questions:
      - What default text pages are shown to users for a language in my sign-up flow?
      - Can I see the out-of-the-box page content for one user flow language?
      instructions:
      - text: List the default pages for language {language} in flow {flow}.
        slots:
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      - text: Show the first {top} default pages of language {language} on flow {flow}.
        slots:
          top: query.$top
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/defaultPages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a default page for a user flow language
      effect: write
      questions:
      - How do I add a new default page entry to a user flow language?
      - Can I create a default page record under a language configuration?
      instructions:
      - text: Create default page {page} under language {language} of flow {flow}.
        slots:
          page: requestBody.id
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      - text: Add a new default page to the {language} language of user flow {flow}.
        slots:
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/defaultPages/{userFlowLanguagePage-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one default page of a user flow language
      effect: read
      questions:
      - What does one specific default page look like for a language in my user flow?
      - Which properties does a single default language page record have?
      instructions:
      - text: Get default page {page} of language {language} in flow {flow}.
        slots:
          page: path.userFlowLanguagePage-id
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      - text: Show the default page record {page} for language {language} on flow {flow}.
        slots:
          page: path.userFlowLanguagePage-id
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/defaultPages/{userFlowLanguagePage-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a default page record
      effect: destructive
      questions:
      - How do I delete a default page entity from a user flow language?
      - Can a default language page record be removed entirely?
      instructions:
      - text: Delete default page {page} from language {language} of flow {flow}.
        slots:
          page: path.userFlowLanguagePage-id
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      - text: Remove the default page entity {page} under {language} in user flow {flow}.
        slots:
          page: path.userFlowLanguagePage-id
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/defaultPages/{userFlowLanguagePage-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a default page record
      effect: write
      questions:
      - How do I update the properties of a default page entity in a user flow language?
      - Can I patch a default language page record itself rather than its content?
      instructions:
      - text: Update default page record {page} of language {language} in flow {flow}.
        slots:
          page: path.userFlowLanguagePage-id
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      - text: Patch the default page entity {page} under {language} on user flow {flow}.
        slots:
          page: path.userFlowLanguagePage-id
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/defaultPages/{userFlowLanguagePage-id}/$value'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the content of a default page
      effect: read
      questions:
      - How do I read the actual values shown to users on a default language page?
      - Can I download the raw content file of a default user flow page?
      instructions:
      - text: Download the content of default page {page} for language {language} in flow {flow}.
        slots:
          page: path.userFlowLanguagePage-id
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      - text: Get the raw text values of default page {page} under {language} on flow {flow}.
        slots:
          page: path.userFlowLanguagePage-id
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/defaultPages/{userFlowLanguagePage-id}/$value'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the content of a default page
      effect: write
      questions:
      - How do I upload new media content for a default language page?
      - Can I overwrite the content file stored on a default user flow page?
      instructions:
      - text: Upload new content for default page {page} of language {language} in flow {flow}.
        slots:
          page: path.userFlowLanguagePage-id
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      - text: Replace the stored content of default page {page} under {language} on flow {flow}.
        slots:
          page: path.userFlowLanguagePage-id
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/defaultPages/{userFlowLanguagePage-id}/$value'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the content of a default page
      effect: destructive
      questions:
      - How do I clear the media content stored on a default language page?
      - Can I delete just the content file of a default page but keep the page record?
      instructions:
      - text: Delete the content of default page {page} for language {language} in flow {flow}.
        slots:
          page: path.userFlowLanguagePage-id
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      - text: Clear the stored content file on default page {page} under {language}, flow {flow}.
        slots:
          page: path.userFlowLanguagePage-id
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/b2xUserFlows/{b2xIdentityUserFlow-id}/languages/{userFlowLanguageConfiguration-id}/defaultPages/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count default pages for a user flow language
      effect: read
      questions:
      - How many default pages exist for one language in my user flow?
      - What is the total of default pages under a language configuration?
      instructions:
      - text: Count the default pages of language {language} in flow {flow}.
        slots:
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      - text: Give me the number of default pages under {language} on user flow {flow}.
        slots:
          language: path.userFlowLanguageConfiguration-id
          flow: path.b2xIdentityUserFlow-id
      method: generated
      generated: '2026-10-01'


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