Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for User Accounts API

3 actions 3 updates phrasing extends openapi/palo-alto-networks-user-accounts-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 3

$.info

$.paths['/iam/v1/sso_users'].get

$.paths['/iam/v1/sso_users'].post

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 User Accounts API
  version: 1.0.0
extends: openapi/palo-alto-networks-user-accounts-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: 2
- target: $.paths['/iam/v1/sso_users'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether an email has a login account
      effect: read
      questions:
      - Does this email address already have a Palo Alto Networks login account?
      - How can I tell if a user needs an SSO account before assigning access?
      instructions:
      - text: Check whether {email} has a login account.
        slots:
          email: query.email
      - text: Verify the user account for {email}.
        slots:
          email: query.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/iam/v1/sso_users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an SSO login account
      effect: write
      questions:
      - How do I create an SSO account for a new user?
      - What happens if I create an SSO account for an email that already exists?
      instructions:
      - text: Create an SSO account for {firstname} {lastname} at {email}.
        slots:
          firstname: requestBody.firstname
          lastname: requestBody.lastname
          email: requestBody.email
      - text: Set up a login account for {email} named {firstname} {lastname}.
        slots:
          email: requestBody.email
          firstname: requestBody.firstname
          lastname: requestBody.lastname
      method: generated
      generated: '2026-10-01'