Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Exposure Lockout policy API

3 actions 3 updates phrasing extends openapi/tenable-lockout-policy-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/api/lockout-policy'].get

$.paths['/api/lockout-policy'].patch

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 Identity Exposure Lockout policy API
  version: 1.0.0
extends: openapi/tenable-lockout-policy-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: 2
- target: $.paths['/api/lockout-policy'].get
  update:
    x-apievangelist-phrasing:
      intent: View the account lockout policy
      effect: read
      questions:
      - How many failed logins lock an account?
      - Is the lockout policy enabled right now?
      instructions:
      - text: Show the lockout policy.
      - text: Get the current account lockout settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/lockout-policy'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the account lockout policy
      effect: write
      questions:
      - Can I lengthen how long accounts stay locked out?
      - How do I change the failed attempt threshold?
      instructions:
      - text: Lock accounts for {lockoutDuration} after {failedAttemptThreshold} failed attempts.
        slots:
          lockoutDuration: requestBody.lockoutDuration
          failedAttemptThreshold: requestBody.failedAttemptThreshold
      - text: Set the lockout policy enabled to {enabled}.
        slots:
          enabled: requestBody.enabled
      method: generated
      generated: '2026-10-01'