Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Palo Alto Networks 3.0 Branch User API

9 actions 9 updates phrasing extends openapi/palo-alto-networks-branch-user-api-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 9

$.info
$.paths['/insights/v3.0/resource/export/query/users/branch/user_list'].post
$.paths['/insights/v3.0/resource/query/branch/risky_user_count'].post
$.paths['/insights/v3.0/resource/query/users/branch/active_user_count'].post
$.paths['/insights/v3.0/resource/query/users/branch/active_user_list'].post
$.paths['/insights/v3.0/resource/query/users/branch/connected_entity_count'].post
$.paths['/insights/v3.0/resource/query/users/branch/session_list'].post
$.paths['/insights/v3.0/resource/query/users/branch/user_count_histogram'].post
$.paths['/insights/v3.0/resource/query/users/branch/user_list'].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 Palo Alto Networks 3.0 Branch User API
  version: 1.0.0
extends: openapi/palo-alto-networks-branch-user-api-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: 8
- target: $.paths['/insights/v3.0/resource/export/query/users/branch/user_list'].post
  update:
    x-apievangelist-phrasing:
      intent: Export the branch user list
      effect: read
      questions:
      - Can I export all branch users with their devices and applications?
      - Is there a bulk export of branch user details for reporting?
      instructions:
      - text: Export the branch user list for region {region}.
        slots:
          region: header.X-PANW-Region
      - text: Export branch users with device and app details in {region} matching {filter}.
        slots:
          region: header.X-PANW-Region
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insights/v3.0/resource/query/branch/risky_user_count'].post
  update:
    x-apievangelist-phrasing:
      intent: Count risky branch users
      effect: read
      questions:
      - How many risky users are there at our branches?
      - Can I count risky users with a filter applied, like a time range?
      instructions:
      - text: Count risky users in region {region}.
        slots:
          region: header.X-PANW-Region
      - text: Get the risky user count in {region} using filter {filter}.
        slots:
          region: header.X-PANW-Region
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insights/v3.0/resource/query/users/branch/active_user_count'].post
  update:
    x-apievangelist-phrasing:
      intent: Count active branch users
      effect: read
      questions:
      - How many users are active at branch sites right now?
      - What's the number of active branch users for my tenant?
      instructions:
      - text: Count active branch users in region {region}.
        slots:
          region: header.X-PANW-Region
      - text: Get the active branch user count in {region} for tenant {tenant}.
        slots:
          region: header.X-PANW-Region
          tenant: header.Prisma-Tenant
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insights/v3.0/resource/query/users/branch/active_user_list'].post
  update:
    x-apievangelist-phrasing:
      intent: List active branch users
      effect: read
      questions:
      - Who are the active users at our branch offices?
      - Can I see the names of currently active branch users?
      instructions:
      - text: List active branch users in region {region}.
        slots:
          region: header.X-PANW-Region
      - text: Show active branch users in {region} matching {filter}.
        slots:
          region: header.X-PANW-Region
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insights/v3.0/resource/query/users/branch/connected_entity_count'].post
  update:
    x-apievangelist-phrasing:
      intent: Count connected entities for branch users
      effect: read
      questions:
      - How many entities are connected for branch users?
      - What's the connected entity count across branch sites?
      instructions:
      - text: Count connected entities for branch users in region {region}.
        slots:
          region: header.X-PANW-Region
      - text: Get the branch connected entity count in {region} with filter {filter}.
        slots:
          region: header.X-PANW-Region
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insights/v3.0/resource/query/users/branch/session_list'].post
  update:
    x-apievangelist-phrasing:
      intent: List branch user sessions
      effect: read
      questions:
      - What sessions have branch users had recently?
      - Can I list branch user sessions filtered by user or site?
      instructions:
      - text: List branch user sessions in region {region}.
        slots:
          region: header.X-PANW-Region
      - text: Show branch sessions in {region} matching {filter}.
        slots:
          region: header.X-PANW-Region
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insights/v3.0/resource/query/users/branch/user_count_histogram'].post
  update:
    x-apievangelist-phrasing:
      intent: Chart branch user counts over time
      effect: read
      questions:
      - How has the number of branch users trended over time?
      - Can I get a histogram of branch user counts for a dashboard?
      instructions:
      - text: Get the branch user count histogram for region {region}.
        slots:
          region: header.X-PANW-Region
      - text: Build a branch user histogram in {region} using filter {filter}.
        slots:
          region: header.X-PANW-Region
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insights/v3.0/resource/query/users/branch/user_list'].post
  update:
    x-apievangelist-phrasing:
      intent: List branch users with device and app details
      effect: read
      questions:
      - Which branch users are there, and what devices and apps do they use?
      - How do I query branch users with device and application details without exporting?
      instructions:
      - text: List branch users with devices and apps in region {region}.
        slots:
          region: header.X-PANW-Region
      - text: Query branch users in {region} matching {filter}.
        slots:
          region: header.X-PANW-Region
          filter: requestBody.filter
      method: generated
      generated: '2026-09-26'