Matomo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Matomo Reporting API for plugin Two Factor Auth API

2 actions 2 updates phrasing extends openapi/matomo-two-factor-auth-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Matomo's API. It is a proposal applied on top of the contract, not a document Matomo publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/index.php?module=API&method=TwoFactorAuth.resetTwoFactorAuth'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Matomo Reporting API for plugin Two Factor Auth API
  version: 1.0.0
extends: openapi/matomo-two-factor-auth-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: 1
- target: $.paths['/index.php?module=API&method=TwoFactorAuth.resetTwoFactorAuth'].get
  update:
    x-apievangelist-phrasing:
      intent: Reset two-factor authentication for a user
      effect: destructive
      questions:
      - A user lost their authenticator app; can I turn off their two-factor login?
      - Does disabling someone's 2FA require me to confirm my password?
      instructions:
      - text: Disable two-factor authentication for user {userLogin}.
        slots:
          userLogin: query.userLogin
      - text: Reset 2FA for {userLogin}, confirming with my password {passwordConfirmation}.
        slots:
          userLogin: query.userLogin
          passwordConfirmation: query.passwordConfirmation
      method: generated
      generated: '2026-10-01'