Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Services MFA Servers API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-mfa-servers-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['/mfa-servers'].get
$.paths['/mfa-servers'].post
$.paths['/mfa-servers/{id}'].get
$.paths['/mfa-servers/{id}'].put
$.paths['/mfa-servers/{id}'].delete
$.paths['/sse/config/v1/mfa-servers'].get
$.paths['/sse/config/v1/mfa-servers'].post
$.paths['/sse/config/v1/mfa-servers/{id}'].get
$.paths['/sse/config/v1/mfa-servers/{id}'].put
$.paths['/sse/config/v1/mfa-servers/{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 MFA Servers API
  version: 1.0.0
extends: openapi/palo-alto-networks-mfa-servers-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['/mfa-servers'].get
  update:
    x-apievangelist-phrasing:
      intent: List MFA server profiles
      effect: read
      questions:
      - Which MFA server profiles are configured in Strata Cloud Manager?
      - Can I list MFA servers defined in one folder?
      instructions:
      - text: List MFA servers at position {position}.
        slots:
          position: query.position
      - text: List MFA servers in folder {folder} at position {position}.
        slots:
          folder: query.folder
          position: query.position
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mfa-servers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an MFA server profile
      effect: write
      questions:
      - How do I connect an MFA vendor to Strata Cloud Manager?
      - Which certificate profile does a new MFA server profile need?
      instructions:
      - text: Create MFA server {name} using certificate profile {cert_profile}.
        slots:
          name: requestBody.name
          cert_profile: requestBody.mfa_cert_profile
      - text: Add MFA server {name} for vendor {vendor} with certificate profile {cert_profile}.
        slots:
          name: requestBody.name
          vendor: requestBody.mfa_vendor_type
          cert_profile: requestBody.mfa_cert_profile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mfa-servers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an MFA server profile
      effect: read
      questions:
      - Where can I see one MFA server profile?
      - What vendor type and certificate profile does an MFA server use?
      instructions:
      - text: Get MFA server {id}.
        slots:
          id: path.id
      - text: Show the vendor settings of MFA server {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mfa-servers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an MFA server profile
      effect: write
      questions:
      - How do I switch an MFA server to a different certificate profile?
      - Can I change the vendor type of an existing MFA server?
      instructions:
      - text: Update MFA server {id} named {name} to certificate profile {cert_profile}.
        slots:
          id: path.id
          name: requestBody.name
          cert_profile: requestBody.mfa_cert_profile
      - text: Change the vendor of MFA server {id} to {vendor}.
        slots:
          id: path.id
          vendor: requestBody.mfa_vendor_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/mfa-servers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an MFA server profile
      effect: destructive
      questions:
      - Can I remove an MFA server profile?
      - Will deleting an MFA server profile break authentication that uses it?
      instructions:
      - text: Delete MFA server {id}.
        slots:
          id: path.id
      - text: Remove the MFA server profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/mfa-servers'].get
  update:
    x-apievangelist-phrasing:
      intent: List MFA servers in a folder
      effect: read
      questions:
      - Which multi-factor authentication servers are configured in a folder?
      - Can I find an MFA server by name?
      instructions:
      - text: List MFA servers in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the MFA server named {name} in {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/mfa-servers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an MFA server
      effect: write
      questions:
      - How do I add a multi-factor authentication server?
      - What certificate profile does a new MFA server need?
      instructions:
      - text: Create MFA server {name} with cert profile {mfa_cert_profile} in folder {folder} at position {position}.
        slots:
          name: requestBody.name
          mfa_cert_profile: requestBody.mfa_cert_profile
          folder: query.folder
          position: query.position
      - text: Add a {mfa_vendor_type} MFA server {name} to {folder}, position {position}, profile {mfa_cert_profile}.
        slots:
          mfa_vendor_type: requestBody.mfa_vendor_type
          name: requestBody.name
          folder: query.folder
          position: query.position
          mfa_cert_profile: requestBody.mfa_cert_profile
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/mfa-servers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an MFA server
      effect: read
      questions:
      - How can I see the settings of one MFA server?
      - Which vendor type is a given MFA server using?
      instructions:
      - text: Get MFA server {id} from the SSE config v1 path.
        slots:
          id: path.id
      - text: Show the configuration of MFA server {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/mfa-servers/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an MFA server
      effect: write
      questions:
      - Can I change the certificate profile on an existing MFA server?
      - Is switching the vendor type of an MFA server possible?
      instructions:
      - text: Update MFA server {id} ({name}) to use cert profile {mfa_cert_profile}.
        slots:
          id: path.id
          name: requestBody.name
          mfa_cert_profile: requestBody.mfa_cert_profile
      - text: Rename MFA server {id} to {name} keeping profile {mfa_cert_profile}.
        slots:
          id: path.id
          name: requestBody.name
          mfa_cert_profile: requestBody.mfa_cert_profile
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/mfa-servers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an MFA server
      effect: destructive
      questions:
      - How do I remove an MFA server?
      - Can I delete an MFA server by ID?
      instructions:
      - text: Delete MFA server {id} using the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove the multi-factor server with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'