Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Services LDAP Server Profiles API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-ldap-server-profiles-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Palo Alto Networks's API. It is a proposal applied on top of the contract, not a document Palo Alto Networks publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/ldap-server-profiles'].get
$.paths['/ldap-server-profiles'].post
$.paths['/ldap-server-profiles/{id}'].get
$.paths['/ldap-server-profiles/{id}'].put
$.paths['/ldap-server-profiles/{id}'].delete
$.paths['/sse/config/v1/ldap-server-profiles'].get
$.paths['/sse/config/v1/ldap-server-profiles'].post
$.paths['/sse/config/v1/ldap-server-profiles/{id}'].get
$.paths['/sse/config/v1/ldap-server-profiles/{id}'].put
$.paths['/sse/config/v1/ldap-server-profiles/{id}'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity Services LDAP Server Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-ldap-server-profiles-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['/ldap-server-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List LDAP server profiles
      effect: read
      questions:
      - Which LDAP server profiles are configured for directory lookups?
      - Can I list the LDAP server profiles on a single device?
      instructions:
      - text: List LDAP server profiles on device {device}.
        slots:
          device: query.device
      - text: Find the LDAP server profile named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ldap-server-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an LDAP server profile
      effect: write
      questions:
      - How do I connect the firewall to my directory by adding an LDAP server profile?
      - Can I require SSL and server certificate verification for an LDAP profile?
      instructions:
      - text: Create LDAP server profile {name} with ID {id} pointing to servers {server}.
        slots:
          name: requestBody.name
          id: requestBody.id
          server: requestBody.server
      - text: Create LDAP profile {name} (ID {id}) for {server} with base DN {base} and bind DN {bind_dn}.
        slots:
          name: requestBody.name
          id: requestBody.id
          server: requestBody.server
          base: requestBody.base
          bind_dn: requestBody.bind_dn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ldap-server-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an LDAP server profile
      effect: read
      questions:
      - What servers and base DN does a given LDAP server profile use?
      - How can I view one LDAP profile's settings by ID?
      instructions:
      - text: Get LDAP server profile {id}.
        slots:
          id: path.id
      - text: Show the bind and SSL settings of LDAP profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ldap-server-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an LDAP server profile
      effect: write
      questions:
      - How do I change the bind password on an existing LDAP server profile?
      - Can I adjust the LDAP search time limit or retry interval?
      instructions:
      - text: Update LDAP profile {id} named {name} to use servers {server}.
        slots:
          id: path.id
          name: requestBody.name
          server: requestBody.server
      - text: Change LDAP profile {id} ({name}, servers {server}) bind password to {bind_password}.
        slots:
          id: path.id
          name: requestBody.name
          server: requestBody.server
          bind_password: requestBody.bind_password
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ldap-server-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an LDAP server profile
      effect: destructive
      questions:
      - How do I delete an LDAP server profile?
      - Is an LDAP profile removed by ID?
      instructions:
      - text: Delete LDAP server profile {id}.
        slots:
          id: path.id
      - text: Remove LDAP profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/ldap-server-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List LDAP server profiles
      effect: read
      questions:
      - Which LDAP server profiles are set up in my folder?
      - Can I look up an LDAP server profile by name?
      instructions:
      - text: List the LDAP server profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find LDAP server profile {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/ldap-server-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an LDAP server profile
      effect: write
      questions:
      - How do I connect my LDAP directory by creating a server profile?
      - Can I require SSL and server certificate verification on a new LDAP profile?
      instructions:
      - text: Create an LDAP server profile in folder {folder} for servers {server}.
        slots:
          folder: query.folder
          server: requestBody.server
      - text: Create an LDAP profile in {folder} for {server} with base DN {base}, bind DN {bind_dn}, SSL {ssl}.
        slots:
          folder: query.folder
          server: requestBody.server
          base: requestBody.base
          bind_dn: requestBody.bind_dn
          ssl: requestBody.ssl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/ldap-server-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an LDAP server profile
      effect: read
      questions:
      - What servers and bind DN does a specific LDAP profile use?
      - Can I fetch an LDAP server profile by ID?
      instructions:
      - text: Get LDAP server profile {id} from the SSE config v1 path.
        slots:
          id: path.id
      - text: Show the servers and SSL settings of LDAP profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/ldap-server-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an LDAP server profile
      effect: write
      questions:
      - Can I change the LDAP servers or bind password on an existing profile?
      - What's the way to adjust the timeout on an LDAP server profile?
      instructions:
      - text: Point LDAP server profile {id} at servers {server}.
        slots:
          id: path.id
          server: requestBody.server
      - text: Update LDAP profile {id} (servers {server}) with bind password {bind_password}.
        slots:
          id: path.id
          server: requestBody.server
          bind_password: requestBody.bind_password
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/ldap-server-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an LDAP server profile
      effect: destructive
      questions:
      - How do I remove an LDAP server profile?
      - Can I delete an LDAP profile by its ID?
      instructions:
      - text: Delete LDAP server profile {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove LDAP profile {id} from the configuration.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'