Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Services Authentication Portals API

10 actions 10 updates phrasing extends openapi/palo-alto-networks-authentication-portals-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 10

$.info

$.paths['/authentication-portals'].get

$.paths['/authentication-portals'].post

$.paths['/authentication-portals/{id}'].get

$.paths['/authentication-portals/{id}'].put

$.paths['/authentication-portals/{id}'].delete

$.paths['/sse/config/v1/authentication-portals'].get

$.paths['/sse/config/v1/authentication-portals'].post

$.paths['/sse/config/v1/authentication-portals/{id}'].put

$.paths['/sse/config/v1/authentication-portals/{id}'].delete

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 Services Authentication Portals API
  version: 1.0.0
extends: openapi/palo-alto-networks-authentication-portals-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: 9
- target: $.paths['/authentication-portals'].get
  update:
    x-apievangelist-phrasing:
      intent: List authentication portals
      effect: read
      questions:
      - Which authentication portals are configured in my Strata Cloud Manager folders?
      - Can I filter authentication portals by folder, snippet or device?
      instructions:
      - text: List authentication portals in folder {folder}.
        slots:
          folder: query.folder
      - text: Show authentication portals defined on device {device}.
        slots:
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authentication-portals'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an authentication portal
      effect: write
      questions:
      - How do I set up a new authentication portal with a redirect host and TLS profile?
      - Can I set an idle timeout when creating an authentication portal?
      instructions:
      - text: Create an authentication portal redirecting to {redirect_host} using auth profile {authentication_profile}.
        slots:
          redirect_host: requestBody.redirect_host
          authentication_profile: requestBody.authentication_profile
      - text: Add an authentication portal with TLS service profile {tls_service_profile} and idle timer {idle_timer} minutes.
        slots:
          tls_service_profile: requestBody.tls_service_profile
          idle_timer: requestBody.idle_timer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authentication-portals/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an authentication portal
      effect: read
      questions:
      - What settings does a particular authentication portal have?
      - Can I look up an authentication portal by its UUID?
      instructions:
      - text: Get authentication portal {id}.
        slots:
          id: path.id
      - text: Show the redirect host and profiles of authentication portal {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authentication-portals/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an authentication portal
      effect: write
      questions:
      - How do I change the certificate profile on an existing authentication portal?
      - Can I change the UDP port used for inbound authentication prompts on a portal I already have?
      instructions:
      - text: Set the certificate profile of authentication portal {id} to {certificate_profile}.
        slots:
          id: path.id
          certificate_profile: requestBody.certificate_profile
      - text: Change authentication portal {id} to use UDP port {gp_udp_port}.
        slots:
          id: path.id
          gp_udp_port: requestBody.gp_udp_port
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authentication-portals/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an authentication portal
      effect: destructive
      questions:
      - How do I remove an authentication portal?
      - Can I delete an authentication portal by UUID?
      instructions:
      - text: Delete authentication portal {id}.
        slots:
          id: path.id
      - text: Remove the authentication portal with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/authentication-portals'].get
  update:
    x-apievangelist-phrasing:
      intent: List authentication portals
      effect: read
      questions:
      - Which authentication portals are configured in a folder?
      - Can I page through authentication portals?
      instructions:
      - text: List the authentication portals in folder {folder}.
        slots:
          folder: query.folder
      - text: Show {limit} authentication portals from {folder}.
        slots:
          limit: query.limit
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/authentication-portals'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an authentication portal
      effect: write
      questions:
      - How do I set up a new authentication portal for users?
      - Can I set the redirect host and idle timer when creating a portal?
      instructions:
      - text: Create an authentication portal in {folder} using authentication profile {authentication_profile}.
        slots:
          folder: query.folder
          authentication_profile: requestBody.authentication_profile
      - text: Add a portal in {folder} redirecting to {redirect_host} with TLS profile {tls_service_profile}.
        slots:
          folder: query.folder
          redirect_host: requestBody.redirect_host
          tls_service_profile: requestBody.tls_service_profile
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/authentication-portals/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an authentication portal
      effect: write
      questions:
      - How do I change the timers on an existing authentication portal?
      - Can I swap the certificate profile on a portal already in use?
      instructions:
      - text: Set the idle timer on authentication portal {id} to {idle_timer}.
        slots:
          id: path.id
          idle_timer: requestBody.idle_timer
      - text: Change existing portal {id} to use certificate profile {certificate_profile}.
        slots:
          id: path.id
          certificate_profile: requestBody.certificate_profile
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/authentication-portals/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an authentication portal
      effect: destructive
      questions:
      - How do I remove an authentication portal through the SSE config v1 API?
      - Can an authentication portal be deleted by its ID?
      instructions:
      - text: Delete authentication portal {id} through the SSE config v1 endpoint.
        slots:
          id: path.id
      - text: Remove the portal with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'