# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Management Attack Protection API
  version: 1.0.0
extends: openapi/auth0-attack-protection-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: 10
- target: $.paths['/attack-protection/bot-detection'].get
  update:
    x-apievangelist-phrasing:
      intent: Get bot detection settings
      effect: read
      questions:
      - What bot detection level is my tenant using?
      - Is bot detection in monitoring mode right now?
      instructions:
      - text: Show my bot detection settings.
      - text: Get the current bot detection configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attack-protection/bot-detection'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update bot detection settings
      effect: write
      questions:
      - How do I raise the bot detection level for logins?
      - Can I allowlist certain IPs from bot detection challenges?
      instructions:
      - text: Set the bot detection level to {bot_detection_level}.
        slots:
          bot_detection_level: requestBody.bot_detection_level
      - text: Allowlist {allowlist} from bot detection.
        slots:
          allowlist: requestBody.allowlist
      - text: Turn bot detection monitoring mode to {monitoring_mode_enabled}.
        slots:
          monitoring_mode_enabled: requestBody.monitoring_mode_enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attack-protection/breached-password-detection'].get
  update:
    x-apievangelist-phrasing:
      intent: Get breached password detection settings
      effect: read
      questions:
      - Is breached password detection enabled on my tenant?
      - What actions happen when a leaked password is detected?
      instructions:
      - text: Show breached password detection settings.
      - text: Get my leaked credential protection configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attack-protection/breached-password-detection'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update breached password detection
      effect: write
      questions:
      - How do I turn on breached password detection?
      - Can I change how often admins are notified about breached passwords?
      instructions:
      - text: Set breached password detection enabled to {enabled}.
        slots:
          enabled: requestBody.enabled
      - text: Use shields {shields} for breached password detection.
        slots:
          shields: requestBody.shields
      - text: Notify admins about breached passwords {admin_notification_frequency}.
        slots:
          admin_notification_frequency: requestBody.admin_notification_frequency
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attack-protection/brute-force-protection'].get
  update:
    x-apievangelist-phrasing:
      intent: Get brute-force protection settings
      effect: read
      questions:
      - How many failed login attempts trigger brute-force protection?
      - Is brute-force protection enabled for my tenant?
      instructions:
      - text: Show brute-force protection settings.
      - text: Get the brute-force max attempts and allowlist.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attack-protection/brute-force-protection'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update brute-force protection
      effect: write
      questions:
      - Can I change the maximum failed attempts before an account is blocked?
      - How do I exempt an office IP from brute-force blocking?
      instructions:
      - text: Set brute-force max attempts to {max_attempts}.
        slots:
          max_attempts: requestBody.max_attempts
      - text: Add {allowlist} to the brute-force allowlist.
        slots:
          allowlist: requestBody.allowlist
      - text: Set brute-force protection enabled to {enabled}.
        slots:
          enabled: requestBody.enabled
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attack-protection/captcha'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the CAPTCHA configuration
      effect: read
      questions:
      - Which CAPTCHA provider is active on my login pages?
      - Can I see the current CAPTCHA settings?
      instructions:
      - text: Show my CAPTCHA configuration.
      - text: Get the active CAPTCHA provider.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attack-protection/captcha'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the CAPTCHA provider or settings
      effect: write
      questions:
      - How do I switch the login CAPTCHA to hCaptcha or reCAPTCHA Enterprise?
      - Can I configure the simple built-in CAPTCHA?
      instructions:
      - text: Set the active CAPTCHA provider to {active_provider_id}.
        slots:
          active_provider_id: requestBody.active_provider_id
      - text: Configure hCaptcha with {hcaptcha}.
        slots:
          hcaptcha: requestBody.hcaptcha
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attack-protection/suspicious-ip-throttling'].get
  update:
    x-apievangelist-phrasing:
      intent: Get suspicious IP throttling settings
      effect: read
      questions:
      - Is suspicious IP throttling turned on?
      - What limits apply to IPs with many failed logins?
      instructions:
      - text: Show suspicious IP throttling settings.
      - text: Get the IP throttling allowlist and stages.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attack-protection/suspicious-ip-throttling'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update suspicious IP throttling
      effect: write
      questions:
      - How do I allowlist an IP range from suspicious IP throttling?
      - Can I change the thresholds for throttling suspicious IP addresses?
      instructions:
      - text: Set suspicious IP throttling enabled to {enabled}.
        slots:
          enabled: requestBody.enabled
      - text: Exempt {allowlist} from IP throttling.
        slots:
          allowlist: requestBody.allowlist
      - text: Set IP throttling stages to {stage}.
        slots:
          stage: requestBody.stage
      method: generated
      generated: '2026-10-01'