Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Incident Security Service Posture Management SaaS Instance…

10 actions 10 updates phrasing extends openapi/palo-alto-networks-saas-instance-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['/sspm/identity/v1/saas_instances'].get
$.paths['/sspm/identity/v1/saas_instances/{saasInstanceId}/saas_accounts'].get
$.paths['/sspm/identity/v1/saas_instances/{saasInstanceId}/saas_accounts/count'].get
$.paths['/sspm/identity/v1/saas_instances/{saasInstanceId}/saas_accounts/csv_report'].post
$.paths['/sspm/identity/v1/saas_instances/{saasInstanceId}/saas_activity'].get
$.paths['/sspm/identity/v1/{saasInstanceId}/tickets'].get
$.paths['/sspm/identity/v1/{saasInstanceId}/tickets'].post
$.paths['/sspm/identity/v1/{saasInstanceId}/tickets'].delete
$.paths['/sspm/identity/v1/{saasInstanceId}/tickets/{ticketKey}/issues'].get

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 Incident Security Service Posture Management SaaS Instance…
  version: 1.0.0
extends: openapi/palo-alto-networks-saas-instance-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: 9
- target: $.paths['/sspm/identity/v1/saas_instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List connected SaaS instances
      effect: read
      questions:
      - Which SaaS applications are connected to my SSPM tenant?
      - What app type and display name does each SaaS instance have?
      instructions:
      - text: List the SaaS instances configured for my tenant.
      - text: Show all SaaS instances for tenant {tenant}.
        slots:
          tenant: header.x-ps-tenant
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/identity/v1/saas_instances/{saasInstanceId}/saas_accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List user accounts in a SaaS instance
      effect: read
      questions:
      - Who has an account in one of my connected SaaS apps, and what roles do they hold?
      - Can I sort and page through SaaS user accounts with a filter?
      instructions:
      - text: List the user accounts in SaaS instance {saasInstanceId}.
        slots:
          saasInstanceId: path.saasInstanceId
      - text: Show accounts in {saasInstanceId} matching {filter}, sorted by {sortBy}.
        slots:
          saasInstanceId: path.saasInstanceId
          filter: query.filter
          sortBy: query.sortBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/identity/v1/saas_instances/{saasInstanceId}/saas_accounts/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count user accounts in a SaaS instance
      effect: read
      questions:
      - How many user accounts exist in a given SaaS app?
      - Can I count only admin or inactive accounts in a SaaS instance?
      instructions:
      - text: Count the accounts in SaaS instance {saasInstanceId}.
        slots:
          saasInstanceId: path.saasInstanceId
      - text: Give me the number of accounts in {saasInstanceId} that match {filter}.
        slots:
          saasInstanceId: path.saasInstanceId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/identity/v1/saas_instances/{saasInstanceId}/saas_accounts/csv_report'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a CSV report of SaaS accounts
      effect: write
      questions:
      - Can I get a CSV export of everyone who has access to a SaaS app for an audit?
      - How do I generate an account report for one SaaS instance?
      instructions:
      - text: Generate a CSV account report for SaaS instance {saasInstanceId} and send it to {userEmail}.
        slots:
          saasInstanceId: path.saasInstanceId
          userEmail: requestBody.userEmail
      - text: Build the {service} account CSV for {saasInstanceId}, requested by {userFullName} at {userEmail}.
        slots:
          service: requestBody.service
          saasInstanceId: path.saasInstanceId
          userFullName: requestBody.userFullName
          userEmail: requestBody.userEmail
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/identity/v1/saas_instances/{saasInstanceId}/saas_activity'].get
  update:
    x-apievangelist-phrasing:
      intent: Get activity logs for a SaaS instance
      effect: read
      questions:
      - What have users been doing inside a connected SaaS app, and from where?
      - Can I filter SaaS activity logs to audit specific actions?
      instructions:
      - text: Show the activity logs for SaaS instance {saasInstanceId}.
        slots:
          saasInstanceId: path.saasInstanceId
      - text: Pull {limit} activity log entries from {saasInstanceId} matching {filter}.
        slots:
          limit: query.limit
          saasInstanceId: path.saasInstanceId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/identity/v1/{saasInstanceId}/tickets'].get
  update:
    x-apievangelist-phrasing:
      intent: List remediation tickets for a SaaS instance
      effect: read
      questions:
      - Which remediation tickets are open for misconfigurations in a SaaS app?
      - Can I filter the tickets tracked against a SaaS instance?
      instructions:
      - text: List the tickets for SaaS instance {saasInstanceId}.
        slots:
          saasInstanceId: path.saasInstanceId
      - text: Show tickets on {saasInstanceId} matching {filter}.
        slots:
          saasInstanceId: path.saasInstanceId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/identity/v1/{saasInstanceId}/tickets'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a remediation ticket for a SaaS instance
      effect: write
      questions:
      - How do I open a ticket to track fixing a flagged SaaS misconfiguration?
      - Can a ticket cover several flagged resources at once?
      instructions:
      - text: Create a ticket on {saasInstanceId} titled {summary} for resources {resourceIds}.
        slots:
          saasInstanceId: path.saasInstanceId
          summary: requestBody.summary
          resourceIds: requestBody.resourceIds
      - text: Open a {type} ticket via integration {integrationId} for the {feature} finding in {saasInstanceId}.
        slots:
          type: requestBody.type
          integrationId: requestBody.integrationId
          feature: requestBody.feature
          saasInstanceId: path.saasInstanceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/identity/v1/{saasInstanceId}/tickets'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete or unlink SaaS instance tickets
      effect: destructive
      questions:
      - How do I unlink a resolved ticket from a SaaS instance?
      - Can I delete tickets that were opened by mistake?
      instructions:
      - text: Delete ticket {id} from SaaS instance {saasInstanceId}.
        slots:
          id: requestBody.id
          saasInstanceId: path.saasInstanceId
      - text: Unlink ticket {id} for the {feature} finding on {saasInstanceId}.
        slots:
          id: requestBody.id
          feature: requestBody.feature
          saasInstanceId: path.saasInstanceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sspm/identity/v1/{saasInstanceId}/tickets/{ticketKey}/issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List issues linked to a SaaS ticket
      effect: read
      questions:
      - Which individual issues are attached to a specific remediation ticket?
      - Can I page through the issues on one ticket?
      instructions:
      - text: List the issues linked to ticket {ticketKey} in {saasInstanceId}.
        slots:
          ticketKey: path.ticketKey
          saasInstanceId: path.saasInstanceId
      - text: Show page {page} of issues on ticket {ticketKey} for SaaS instance {saasInstanceId}.
        slots:
          page: query.page
          ticketKey: path.ticketKey
          saasInstanceId: path.saasInstanceId
      method: generated
      generated: '2026-09-26'