Tenable · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Exposure LDAP configuration API

3 actions 3 updates phrasing extends openapi/tenable-ldap-configuration-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/ldap-configuration'].get

$.paths['/api/ldap-configuration'].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 LDAP configuration API
  version: 1.0.0
extends: openapi/tenable-ldap-configuration-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/ldap-configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: View LDAP sign-in configuration
      effect: read
      questions:
      - Is LDAP authentication turned on for Identity Exposure?
      - Which LDAP server and search base are used for sign-in?
      instructions:
      - text: Show the LDAP configuration.
      - text: Get LDAP sign-in settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/ldap-configuration'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update LDAP sign-in configuration
      effect: write
      questions:
      - How do I enable LDAP sign-in?
      - Can I restrict LDAP login to certain groups?
      - Can I change the LDAP server URL used for authentication?
      instructions:
      - text: 'Enable LDAP sign-in: {enabled}, using server {url}.'
        slots:
          enabled: requestBody.enabled
          url: requestBody.url
      - text: Allow only LDAP groups {allowedGroups} to sign in.
        slots:
          allowedGroups: requestBody.allowedGroups
      - text: Set the LDAP user search base to {userSearchBase} with filter {userSearchFilter}.
        slots:
          userSearchBase: requestBody.userSearchBase
          userSearchFilter: requestBody.userSearchFilter
      method: generated
      generated: '2026-10-01'