# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Authentication MFA API
  version: 1.0.0
extends: openapi/auth0-mfa-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: 4
- target: $.paths['/mfa/challenge'].post
  update:
    x-apievangelist-phrasing:
      intent: Request an MFA challenge
      effect: write
      questions:
      - How do I trigger an SMS or push MFA challenge during login?
      - Can I choose which authenticator receives the MFA challenge?
      instructions:
      - text: Request an MFA challenge using token {mfa_token}.
        slots:
          mfa_token: requestBody.mfa_token
      - text: Send a {challenge_type} challenge to authenticator {authenticator_id} for MFA token {mfa_token}.
        slots:
          challenge_type: requestBody.challenge_type
          authenticator_id: requestBody.authenticator_id
          mfa_token: requestBody.mfa_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mfa/associate'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll a new MFA authenticator
      effect: write
      questions:
      - How does a user add a new authenticator like OTP or SMS for MFA?
      - Can I enroll a phone number as an out-of-band MFA channel?
      instructions:
      - text: Associate a {authenticator_types} authenticator for client {client_id}.
        slots:
          authenticator_types: requestBody.authenticator_types
          client_id: requestBody.client_id
      - text: Enroll phone {phone_number} over {oob_channels} for MFA.
        slots:
          phone_number: requestBody.phone_number
          oob_channels: requestBody.oob_channels
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mfa/authenticators'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's MFA authenticators
      effect: read
      questions:
      - Which authenticators has the signed-in user enrolled for MFA?
      - What scope do I need to list authenticators?
      instructions:
      - text: List MFA authenticators using access token {ACCESS_TOKEN}.
        slots:
          ACCESS_TOKEN: header.ACCESS_TOKEN
      - text: Show my enrolled authenticators with token {ACCESS_TOKEN}.
        slots:
          ACCESS_TOKEN: header.ACCESS_TOKEN
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mfa/authenticators/{AUTHENTICATOR_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an MFA authenticator
      effect: destructive
      questions:
      - Can a user remove one of their own MFA authenticators?
      - Where do I get the authenticator ID to delete one?
      instructions:
      - text: Delete authenticator {AUTHENTICATOR_ID} using access token {ACCESS_TOKEN}.
        slots:
          AUTHENTICATOR_ID: path.AUTHENTICATOR_ID
          ACCESS_TOKEN: header.ACCESS_TOKEN
      - text: Remove my MFA authenticator {AUTHENTICATOR_ID} with token {ACCESS_TOKEN}.
        slots:
          AUTHENTICATOR_ID: path.AUTHENTICATOR_ID
          ACCESS_TOKEN: header.ACCESS_TOKEN
      method: generated
      generated: '2026-10-01'