Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for CIE - Cloud Dynamic User Group CRUD Operations APIs Mounted…

7 actions 7 updates phrasing extends openapi/palo-alto-networks-cloud-dynamic-user-groups-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 7

$.info
$.paths['/directory-sync/v1/cloud-dug-definition/category'].get
$.paths['/directory-sync/v1/user-attr-values'].get
$.paths['/directory-sync/v1/cloud-dug-definition'].post
$.paths['/directory-sync/v1/cloud-dug-definition/group'].get
$.paths['/directory-sync/v1/cloud-dug-definition/group'].put
$.paths['/directory-sync/v1/cloud-dug-definition/group'].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 CIE - Cloud Dynamic User Group CRUD Operations APIs Mounted…
  version: 1.0.0
extends: openapi/palo-alto-networks-cloud-dynamic-user-groups-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: 6
- target: $.paths['/directory-sync/v1/cloud-dug-definition/category'].get
  update:
    x-apievangelist-phrasing:
      intent: List dynamic group categories for a directory
      effect: read
      questions:
      - Which categories and context attributes can I use to build cloud dynamic user groups?
      - What is the first call to make before creating a cloud dynamic user group?
      instructions:
      - text: List dynamic user group categories for directory {domain}.
        slots:
          domain: query.domain
      - text: Show the context attributes available in {domain}.
        slots:
          domain: query.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/directory-sync/v1/user-attr-values'].get
  update:
    x-apievangelist-phrasing:
      intent: List the values of a user attribute
      effect: read
      questions:
      - What distinct values does a user attribute like department have in my directory?
      - Can I filter user attribute values by risk source?
      instructions:
      - text: List all values of attribute {attr} in {domain}.
        slots:
          attr: query.attrName
          domain: query.domain
      - text: Show values of {attr} in {domain} for risk source {risk_source}.
        slots:
          attr: query.attrName
          domain: query.domain
          risk_source: query.riskSourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/directory-sync/v1/cloud-dug-definition'].post
  update:
    x-apievangelist-phrasing:
      intent: Create cloud dynamic user groups
      effect: write
      questions:
      - How do I create a user group that updates automatically from directory attributes?
      - Can I define several cloud dynamic user groups in one request?
      instructions:
      - text: Create cloud dynamic user groups {groups} in {domain} with normalized attributes {normalized}.
        slots:
          groups: requestBody.value
          domain: requestBody.domain
          normalized: requestBody.useNormalizedAttrs
      - text: Define new dynamic groups in directory {domain} from constraints {groups}.
        slots:
          domain: requestBody.domain
          groups: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/directory-sync/v1/cloud-dug-definition/group'].get
  update:
    x-apievangelist-phrasing:
      intent: List or look up cloud dynamic user groups
      effect: read
      questions:
      - Which cloud dynamic user groups exist in my directory?
      - Can I fetch all groups in one category or a single group by object GUID?
      instructions:
      - text: List cloud dynamic user groups in {domain} with normalized attributes {normalized}.
        slots:
          domain: query.domain
          normalized: query.useNormalizedAttrs
      - text: Get the cloud dynamic user group {guid} in {domain}.
        slots:
          guid: query.objectGUID
          domain: query.domain
      - text: Show all dynamic groups in category {def_id} across aggregation {aggregation}.
        slots:
          def_id: query.defID
          aggregation: query.aggregationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/directory-sync/v1/cloud-dug-definition/group'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a cloud dynamic user group
      effect: write
      questions:
      - How do I change the attribute constraints of an existing cloud dynamic user group?
      - Can I edit a group I already created instead of recreating it?
      instructions:
      - text: Update cloud dynamic user group definitions {groups} in {domain}.
        slots:
          groups: requestBody.value
          domain: requestBody.domain
      - text: Edit existing groups in {domain} to {groups} using normalized attributes {normalized}.
        slots:
          domain: requestBody.domain
          groups: requestBody.value
          normalized: requestBody.useNormalizedAttrs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/directory-sync/v1/cloud-dug-definition/group'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete cloud dynamic user groups
      effect: destructive
      questions:
      - How do I delete one cloud dynamic user group by its object GUID?
      - Can I wipe every group in a category at once?
      instructions:
      - text: Delete cloud dynamic user group {guid} in {domain}.
        slots:
          guid: query.objectGUID
          domain: query.domain
      - text: Delete all cloud dynamic user groups in category {def_id} of {domain}.
        slots:
          def_id: query.defID
          domain: query.domain
      method: generated
      generated: '2026-09-26'