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

API Evangelist conversational phrasing for Identity.SignIns Policies.authentication Methods Policy API

10 actions 10 updates phrasing extends openapi/azure-ad-policies-authenticationmethodspolicy-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 10

$.info
$.paths['/policies/authenticationMethodsPolicy'].get
$.paths['/policies/authenticationMethodsPolicy'].delete
$.paths['/policies/authenticationMethodsPolicy'].patch
$.paths['/policies/authenticationMethodsPolicy/authenticationMethodConfigurations'].get
$.paths['/policies/authenticationMethodsPolicy/authenticationMethodConfigurations'].post
$.paths['/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{authenticationMethodConfiguration-id}'].get
$.paths['/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{authenticationMethodConfiguration-id}'].delete
$.paths['/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{authenticationMethodConfiguration-id}'].patch
$.paths['/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/$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 Policies.authentication Methods Policy API
  version: 1.0.0
extends: openapi/azure-ad-policies-authenticationmethodspolicy-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: 9
- target: $.paths['/policies/authenticationMethodsPolicy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tenant authentication methods policy
      effect: read
      questions:
      - Which authentication methods are enabled for users in my tenant?
      - How do I check the registration enforcement and migration state of the authentication methods policy?
      instructions:
      - text: Show the tenant's authentication methods policy.
      - text: Get the authentication methods policy with its method configurations.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/authenticationMethodsPolicy'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the authentication methods policy
      effect: destructive
      questions:
      - Can I delete the authentication methods policy object entirely?
      - What call removes the authenticationMethodsPolicy navigation property?
      instructions:
      - text: Delete the tenant's authentication methods policy.
      - text: Remove the authenticationMethodsPolicy from policies.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/authenticationMethodsPolicy'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the authentication methods policy
      effect: write
      questions:
      - How do I change how often users must reconfirm their authentication methods?
      - Can I move the tenant's policy migration state forward from legacy MFA settings?
      - How do I turn on registration enforcement for authentication methods?
      instructions:
      - text: Set authentication method reconfirmation to every {reconfirmationInDays} days.
        slots:
          reconfirmationInDays: requestBody.reconfirmationInDays
      - text: Change the authentication methods policy migration state to {policyMigrationState}.
        slots:
          policyMigrationState: requestBody.policyMigrationState
      - text: Update registration enforcement on the methods policy to {registrationEnforcement}.
        slots:
          registrationEnforcement: requestBody.registrationEnforcement
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/authenticationMethodsPolicy/authenticationMethodConfigurations'].get
  update:
    x-apievangelist-phrasing:
      intent: List authentication method configurations
      effect: read
      questions:
      - What's the configuration of each authentication method, like FIDO2 or SMS, in my tenant?
      - How do I see all external and built-in authentication method configurations?
      instructions:
      - text: List all authentication method configurations.
      - text: Show authentication method configurations matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/authenticationMethodsPolicy/authenticationMethodConfigurations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an authentication method configuration
      effect: write
      questions:
      - How do I add a new external authentication method configuration to the policy?
      - Can I create a method configuration that starts disabled?
      instructions:
      - text: Create an authentication method configuration with state {state}.
        slots:
          state: requestBody.state
      - text: Add a method configuration excluding {excludeTargets}.
        slots:
          excludeTargets: requestBody.excludeTargets
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{authenticationMethodConfiguration-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one authentication method configuration
      effect: read
      questions:
      - Is a specific authentication method enabled, and who is excluded from it?
      - How do I read one external authentication method configuration by ID?
      instructions:
      - text: Get authentication method configuration {method}.
        slots:
          method: path.authenticationMethodConfiguration-id
      - text: Show whether method {method} is enabled and who it excludes.
        slots:
          method: path.authenticationMethodConfiguration-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{authenticationMethodConfiguration-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an authentication method configuration
      effect: destructive
      questions:
      - How do I remove an external authentication method from my tenant?
      - Can I delete one authentication method configuration by ID?
      instructions:
      - text: Delete authentication method configuration {method}.
        slots:
          method: path.authenticationMethodConfiguration-id
      - text: Remove external authentication method {method}.
        slots:
          method: path.authenticationMethodConfiguration-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/{authenticationMethodConfiguration-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Enable, disable or scope an authentication method
      effect: write
      questions:
      - How do I disable a specific authentication method for the whole tenant?
      - Can I exclude a group from using an authentication method?
      instructions:
      - text: Set authentication method {method} to {state}.
        slots:
          method: path.authenticationMethodConfiguration-id
          state: requestBody.state
      - text: Exclude {excludeTargets} from authentication method {method}.
        slots:
          excludeTargets: requestBody.excludeTargets
          method: path.authenticationMethodConfiguration-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count authentication method configurations
      effect: read
      questions:
      - How many authentication method configurations does my tenant have?
      - What's the number of method configurations in the authentication methods policy?
      instructions:
      - text: Count the authentication method configurations.
      - text: Tell me how many methods are configured in the methods policy.
      method: generated
      generated: '2026-10-01'