Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Services SAML Server Profiles API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-saml-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['/saml-server-profiles'].get

$.paths['/saml-server-profiles'].post

$.paths['/saml-server-profiles/{id}'].get

$.paths['/saml-server-profiles/{id}'].put

$.paths['/saml-server-profiles/{id}'].delete

$.paths['/sse/config/v1/saml-server-profiles'].get

$.paths['/sse/config/v1/saml-server-profiles'].post

$.paths['/sse/config/v1/saml-server-profiles/{id}'].get

$.paths['/sse/config/v1/saml-server-profiles/{id}'].put

$.paths['/sse/config/v1/saml-server-profiles/{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 SAML Server Profiles API
  version: 1.0.0
extends: openapi/palo-alto-networks-saml-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['/saml-server-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List SAML server profiles
      effect: read
      questions:
      - Which SAML identity provider profiles are configured for authentication?
      - Can I list SAML server profiles in a specific folder, snippet or device?
      instructions:
      - text: List SAML server profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find SAML server profile {name} on device {device}.
        slots:
          name: query.name
          device: query.device
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saml-server-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a SAML server profile
      effect: write
      questions:
      - How do I register a SAML identity provider for single sign-on?
      - Can I require signed authentication requests on a new SAML profile?
      instructions:
      - text: Create SAML profile {name} with id {id}, IdP entity {entity_id}, SSO URL {sso_url}, bindings {sso_bindings}, certificate {certificate}.
        slots:
          name: requestBody.name
          id: requestBody.id
          entity_id: requestBody.entity_id
          sso_url: requestBody.sso_url
          sso_bindings: requestBody.sso_bindings
          certificate: requestBody.certificate
      - text: Add SAML IdP {name} ({id}) for {entity_id} at {sso_url} via {sso_bindings}, cert {certificate}, max clock skew {max_clock_skew}.
        slots:
          name: requestBody.name
          id: requestBody.id
          entity_id: requestBody.entity_id
          sso_url: requestBody.sso_url
          sso_bindings: requestBody.sso_bindings
          certificate: requestBody.certificate
          max_clock_skew: requestBody.max_clock_skew
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saml-server-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SAML server profile
      effect: read
      questions:
      - What SSO URL and certificate does a given SAML server profile use?
      - How do I fetch one SAML server profile by ID?
      instructions:
      - text: Show SAML server profile {id}.
        slots:
          id: path.id
      - text: Get the IdP settings stored in SAML profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saml-server-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a SAML server profile
      effect: write
      questions:
      - How do I rotate the IdP certificate on an existing SAML server profile?
      - Can I change the single logout URL of a SAML profile?
      instructions:
      - text: Update SAML profile {id} ({name}) with certificate {certificate}, entity {entity_id}, SSO URL {sso_url}, bindings {sso_bindings}.
        slots:
          id: path.id
          name: requestBody.name
          certificate: requestBody.certificate
          entity_id: requestBody.entity_id
          sso_url: requestBody.sso_url
          sso_bindings: requestBody.sso_bindings
      - text: On SAML profile {id} ({name}, {entity_id}, {sso_url}, {sso_bindings}, {certificate}) set logout URL {slo_url}.
        slots:
          id: path.id
          name: requestBody.name
          entity_id: requestBody.entity_id
          sso_url: requestBody.sso_url
          sso_bindings: requestBody.sso_bindings
          certificate: requestBody.certificate
          slo_url: requestBody.slo_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/saml-server-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SAML server profile
      effect: destructive
      questions:
      - How do I remove a SAML identity provider profile we stopped using?
      - Can I delete a SAML server profile by ID?
      instructions:
      - text: Delete SAML server profile {id}.
        slots:
          id: path.id
      - text: Remove the SAML IdP profile with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/saml-server-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List SAML server profiles
      effect: read
      questions:
      - Which SAML identity provider profiles are configured in a folder?
      - Can I look up a SAML server profile by name within a folder?
      instructions:
      - text: List the SSE config SAML server profiles in folder {folder}.
        slots:
          folder: query.folder
      - text: Find SAML server profile {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/saml-server-profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a SAML server profile
      effect: write
      questions:
      - How do I add a SAML identity provider profile with its signing certificate?
      - Can I set the SSO URL and entity ID when creating a SAML server profile?
      instructions:
      - text: Create a SAML server profile in folder {folder} with certificate {certificate}.
        slots:
          folder: query.folder
          certificate: requestBody.certificate
      - text: Add a SAML IdP profile in {folder} with certificate {certificate}, entity ID {entity_id} and SSO URL {sso_url}.
        slots:
          folder: query.folder
          certificate: requestBody.certificate
          entity_id: requestBody.entity_id
          sso_url: requestBody.sso_url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/saml-server-profiles/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a SAML server profile
      effect: read
      questions:
      - Can I read a SAML server profile through the SSE config v1 endpoint?
      - Can I fetch a SAML server profile by its ID?
      instructions:
      - text: Get SAML server profile {id}.
        slots:
          id: path.id
      - text: Show the bindings and certificate of SAML profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/saml-server-profiles/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a SAML server profile
      effect: write
      questions:
      - How do I swap the IdP certificate on a SAML profile through the SSE config v1 API?
      - Can I change the allowed clock skew on a SAML profile?
      instructions:
      - text: Update SAML server profile {id} to use certificate {certificate}.
        slots:
          id: path.id
          certificate: requestBody.certificate
      - text: Set max clock skew {max_clock_skew} on SAML profile {id} with certificate {certificate}.
        slots:
          max_clock_skew: requestBody.max_clock_skew
          id: path.id
          certificate: requestBody.certificate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/saml-server-profiles/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SAML server profile
      effect: destructive
      questions:
      - How do I remove a SAML identity provider profile?
      - Is removing a SAML IdP profile via the SSE v1 API permanent?
      instructions:
      - text: Delete SSE config SAML server profile {id}.
        slots:
          id: path.id
      - text: Remove the SAML IdP profile {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'