Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Services Local Users API

11 actions 11 updates phrasing extends openapi/palo-alto-networks-local-users-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['/local-users'].get
$.paths['/local-users'].post
$.paths['/local-users/{id}'].get
$.paths['/local-users/{id}'].put
$.paths['/local-users/{id}'].delete
$.paths['/sse/config/v1/local-users'].get
$.paths['/sse/config/v1/local-users'].post
$.paths['/sse/config/v1/local-users/{id}'].get
$.paths['/sse/config/v1/local-users/{id}'].put
$.paths['/sse/config/v1/local-users/{id}'].delete

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 Identity Services Local Users API
  version: 1.0.0
extends: openapi/palo-alto-networks-local-users-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['/local-users'].get
  update:
    x-apievangelist-phrasing:
      intent: List local users
      effect: read
      questions:
      - Which local user accounts are configured on my firewalls?
      - Can I list the local users defined in one folder?
      instructions:
      - text: List local users in folder {folder}.
        slots:
          folder: query.folder
      - text: Find the local user named {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/local-users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a local user
      effect: write
      questions:
      - How do I add a local user account in Strata Cloud Manager?
      - Can I create a local user that starts out disabled?
      instructions:
      - text: Create local user {name} with ID {id} and password {password}.
        slots:
          name: requestBody.name
          id: requestBody.id
          password: requestBody.password
      - text: Add local user {name} (ID {id}, password {password}) with disabled {disabled}.
        slots:
          name: requestBody.name
          id: requestBody.id
          password: requestBody.password
          disabled: requestBody.disabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/local-users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a local user
      effect: read
      questions:
      - Is a specific local user account disabled?
      - Can I look up one local user by UUID?
      instructions:
      - text: Get local user {id}.
        slots:
          id: path.id
      - text: Show whether local user {id} is disabled.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/local-users/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a local user
      effect: write
      questions:
      - How do I reset a local user's password?
      - Can I disable an existing local user without deleting it?
      instructions:
      - text: Reset the password of local user {id} (name {name}, body ID {body_id}) to {password}.
        slots:
          id: path.id
          name: requestBody.name
          body_id: requestBody.id
          password: requestBody.password
      - text: Set disabled {disabled} on local user {id}.
        slots:
          disabled: requestBody.disabled
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/local-users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a local user
      effect: destructive
      questions:
      - How do I delete a local user account?
      - What happens when I remove a local user?
      instructions:
      - text: Delete local user {id}.
        slots:
          id: path.id
      - text: Remove the local user account with UUID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sse/config/v1/local-users'].get
  update:
    x-apievangelist-phrasing:
      intent: List local users
      effect: read
      questions:
      - Which local users are defined in a configuration folder?
      - Can I look up a local user by name?
      instructions:
      - text: List the SSE config local users in folder {folder}.
        slots:
          folder: query.folder
      - text: Find local user {name} in folder {folder}.
        slots:
          name: query.name
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/local-users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a local user
      effect: write
      questions:
      - How do I add a local user account with a password?
      - Can I add a disabled local user to a Prisma Access folder via the SSE config API?
      instructions:
      - text: Create local user {name} with password {password} in folder {folder}.
        slots:
          name: requestBody.name
          password: requestBody.password
          folder: query.folder
      - text: Add disabled local user {name} (password {password}) to {folder}.
        slots:
          name: requestBody.name
          password: requestBody.password
          folder: query.folder
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/local-users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a local user
      effect: read
      questions:
      - How do I look up one local user by ID?
      - Is a particular local user account disabled?
      instructions:
      - text: Fetch SSE config local user {id}.
        slots:
          id: path.id
      - text: Check whether local user {id} is disabled.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/local-users/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a local user
      effect: write
      questions:
      - How do I change a local user's password through the SSE config v1 endpoint?
      - Can I disable an existing local user account?
      instructions:
      - text: Change local user {id} ({name}) password to {password}.
        slots:
          id: path.id
          name: requestBody.name
          password: requestBody.password
      - text: Set disabled to {disabled} for local user {id} named {name} with password {password}.
        slots:
          disabled: requestBody.disabled
          id: path.id
          name: requestBody.name
          password: requestBody.password
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sse/config/v1/local-users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a local user
      effect: destructive
      questions:
      - How do I delete a local user through the SSE config v1 API?
      - Can I remove a local user by ID?
      instructions:
      - text: Delete SSE config local user {id}.
        slots:
          id: path.id
      - text: Remove the local user with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'