# 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 Directory Sync Service API
  version: 1.0.0
extends: openapi/palo-alto-networks-directory-sync-service-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: 7
- target: $.paths['https://api.sase.paloaltonetworks.com/cie/directory-sync/v1/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: Check sync status of directory domains
      effect: read
      questions:
      - When did each of my directory domains last sync successfully?
      - How many users and groups were synced for each configured domain?
      instructions:
      - text: Show the sync status, last successful sync time and user and group counts for every directory domain.
      - text: Check whether any of my Directory Sync domains has stopped syncing.
      method: generated
      generated: '2026-10-01'
- target: $.paths['https://api.sase.paloaltonetworks.com/cie/directory-sync/v1/cache-users'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a user's group membership
      effect: read
      questions:
      - Is a particular user a member of a given directory group?
      - Can I find synced directory users by their email address?
      instructions:
      - text: Check whether a user belongs to a specific directory group in my tenant.
      - text: Find synced directory users by email address in one of my domains.
      method: generated
      generated: '2026-10-01'
- target: $.paths['https://api.sase.paloaltonetworks.com/cie/directory-sync/v1/cache-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether a group contains a user
      effect: read
      questions:
      - Does a particular directory group contain a given user?
      - Which groups does one synced user belong to?
      instructions:
      - text: Check whether a directory group contains a particular user.
      - text: List the groups a specific synced user belongs to.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cie/directory-sync/v1/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List directory sync domains
      effect: read
      questions:
      - Which domains are configured in the Cloud Identity Engine Directory Sync Service?
      - What domains has our tenant connected for directory sync?
      instructions:
      - text: List all domains configured in Directory Sync with their details.
      - text: Show me every connected directory domain.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cie/directory-sync/v1/cache-users'].post
  update:
    x-apievangelist-phrasing:
      intent: Query synced directory users
      effect: read
      questions:
      - How do I list every user synced from a directory domain?
      - Can I filter synced users by attribute, like a SQL WHERE clause?
      - Which users are members of one directory group?
      instructions:
      - text: List all synced users in a directory domain, page by page.
      - text: Query synced directory users with an attribute filter on name.
      - text: Retrieve the users who belong to a specified directory group.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cie/directory-sync/v1/cache-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Query synced directory groups
      effect: read
      questions:
      - How do I list every group synced from a directory domain?
      - Can I filter synced groups by attribute, like a SQL WHERE clause?
      instructions:
      - text: List all synced groups in a directory domain, page by page.
      - text: Query synced directory groups with a name-based attribute filter.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cie/directory-sync/v1/connection/update-secret'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a directory connection's client secret
      effect: write
      questions:
      - How do I rotate the client secret on an existing directory connection?
      - What happens to directory sync when our app registration secret expires?
      instructions:
      - text: Update the client secret of directory connection {directoryId} for provider {provider} to {client_secret}.
        slots:
          directoryId: requestBody.directoryId
          provider: requestBody.provider
          client_secret: requestBody.client_secret
      - text: Rotate the {provider} client secret on directory {directoryId} to {client_secret}.
        slots:
          directoryId: requestBody.directoryId
          provider: requestBody.provider
          client_secret: requestBody.client_secret
      method: generated
      generated: '2026-10-01'