Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GlobalProtect Agent Authentication Settings API

6 actions 6 updates phrasing extends openapi/palo-alto-networks-agent-authentication-settings-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 6

$.info
$.paths['/authentication-settings'].get
$.paths['/authentication-settings'].put
$.paths['/authentication-settings'].post
$.paths['/authentication-settings'].delete
$.paths['/authentication-settings/{name}:move'].post

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 GlobalProtect Agent Authentication Settings API
  version: 1.0.0
extends: openapi/palo-alto-networks-agent-authentication-settings-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/authentication-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List GlobalProtect authentication settings
      effect: read
      questions:
      - Which GlobalProtect agent authentication settings are configured?
      - Can I look up a GlobalProtect authentication setting by name in a folder?
      instructions:
      - text: List GlobalProtect authentication settings.
      - text: Find GlobalProtect authentication setting {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authentication-settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a GlobalProtect authentication setting
      effect: write
      questions:
      - How do I change which authentication profile an existing GlobalProtect setting uses?
      - Can I require a client certificate as well as credentials on an existing setting for one OS?
      instructions:
      - text: Update the existing GlobalProtect setting for {os} to use authentication profile {authentication_profile}.
        slots:
          os: requestBody.os
          authentication_profile: requestBody.authentication_profile
      - text: Change the {os} authentication setting so credential or client cert required is {user_credential_or_client_cert_required}, profile {authentication_profile}.
        slots:
          os: requestBody.os
          user_credential_or_client_cert_required: requestBody.user_credential_or_client_cert_required
          authentication_profile: requestBody.authentication_profile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authentication-settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a GlobalProtect authentication setting
      effect: write
      questions:
      - How do I add a new GlobalProtect authentication setting for a specific operating system?
      - What must a new GlobalProtect agent authentication setting include?
      instructions:
      - text: Create a new GlobalProtect authentication setting for {os} using profile {authentication_profile}.
        slots:
          os: requestBody.os
          authentication_profile: requestBody.authentication_profile
      - text: Add a GlobalProtect auth setting in folder {folder} for {os} with profile {authentication_profile} and cert requirement {cert_required}.
        slots:
          folder: query.folder
          os: requestBody.os
          authentication_profile: requestBody.authentication_profile
          cert_required: requestBody.user_credential_or_client_cert_required
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authentication-settings'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a GlobalProtect authentication setting
      effect: destructive
      questions:
      - How do I remove a GlobalProtect authentication setting by name?
      - Can I delete an authentication setting from just one folder?
      instructions:
      - text: Delete GlobalProtect authentication setting {name}.
        slots:
          name: query.name
      - text: Remove authentication setting {name} from folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authentication-settings/{name}:move'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder a GlobalProtect authentication setting
      effect: write
      questions:
      - How do I change the evaluation order of GlobalProtect authentication settings?
      - Can I move an authentication setting to the top of the list?
      instructions:
      - text: Move GlobalProtect authentication setting {name} to {where}.
        slots:
          name: path.name
          where: requestBody.where
      - text: Place authentication setting {name} {where} setting {destination}.
        slots:
          name: path.name
          where: requestBody.where
          destination: requestBody.destination
      method: generated
      generated: '2026-09-26'