API Evangelist conversational phrasing for Progress Software Users API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Progress Software Users API
  version: 1.0.0
extends: openapi/progress-software-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: 19
- target: $.paths['/apis/iam/v2/self/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update my own IAM display name or password
      effect: write
      questions:
      - How do I change my own password as a local IAM user?
      - Do I need my previous password to set a new one on my own account?
      instructions:
      - text: Change my IAM display name for user {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update my own password on IAM user {id} from {previous_password} to {password}, keeping name {name}.
        slots:
          id: path.id
          previous_password: requestBody.previous_password
          password: requestBody.password
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List local IAM users
      effect: read
      questions:
      - Which local IAM users exist in Automate?
      - Can I see every local user who can sign in and join IAM teams?
      instructions:
      - text: List all local IAM users.
      - text: Show me every local user account defined in IAM.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a local IAM user
      effect: write
      questions:
      - How do I create a local IAM user who can sign in and be added to policies?
      - What does a new local IAM user need besides an ID, a name and a password?
      instructions:
      - text: Create local IAM user {id} named {name} with password {password}.
        slots:
          id: requestBody.id
          name: requestBody.name
          password: requestBody.password
      - text: Add a new IAM sign-in for {name} using login ID {id} and password {password}.
        slots:
          name: requestBody.name
          id: requestBody.id
          password: requestBody.password
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a local IAM user
      effect: read
      questions:
      - How do I look up the details of one local IAM user by ID?
      - What membership details does IAM return for a single local user?
      instructions:
      - text: Show the IAM user {id}.
        slots:
          id: path.id
      - text: Get the details of local IAM account {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/users/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update another local IAM user's name or password
      effect: write
      questions:
      - As an admin, how do I reset a local IAM user's password without their old one?
      - Can I rename a local IAM user?
      instructions:
      - text: Rename IAM user {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set a new password {password} for IAM user {id}, keeping name {name}.
        slots:
          password: requestBody.password
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/users/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a local IAM user
      effect: destructive
      questions:
      - How do I delete a local IAM user who has left?
      - Is removing a local IAM user permanent?
      instructions:
      - text: Delete IAM user {id}.
        slots:
          id: path.id
      - text: Remove the local IAM sign-in {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users/self'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my own transfer account details
      effect: read
      questions:
      - Who am I signed in as on the file transfer server?
      - What permission level and email does my current transfer account have?
      instructions:
      - text: Show the details of the transfer user I'm signed in as.
      - text: Get my current account profile from the file transfer server.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transfer user's details
      effect: read
      questions:
      - How do I look up a file transfer user's account by ID?
      - Can I see a transfer user's folder quota and status?
      instructions:
      - text: Show the transfer account details for user {Id}.
        slots:
          Id: path.Id
      - text: Get file transfer user {Id}'s profile.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a transfer user account
      effect: destructive
      questions:
      - How do I delete a file transfer user account?
      - Can I remove a transfer user by their ID?
      instructions:
      - text: Delete transfer user {Id}.
        slots:
          Id: path.Id
      - text: Remove the file transfer account {Id} permanently.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a transfer user's profile
      effect: write
      questions:
      - How do I change a transfer user's email address or full name?
      - Can I suspend a transfer user by changing their status?
      - Is it possible to force a transfer user to change password at next sign-in?
      instructions:
      - text: Change transfer user {Id}'s email to {email}.
        slots:
          Id: path.Id
          email: requestBody.email
      - text: Set transfer user {Id}'s status to {status} with note {statusNote}.
        slots:
          Id: path.Id
          status: requestBody.status
          statusNote: requestBody.statusNote
      - text: Set the folder quota for transfer user {Id} to {folderQuota}.
        slots:
          Id: path.Id
          folderQuota: requestBody.folderQuota
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users/{Id}/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List the groups a transfer user belongs to
      effect: read
      questions:
      - Which groups is a given transfer user a member of?
      - Can I page through a user's group memberships?
      instructions:
      - text: List the groups transfer user {Id} belongs to.
        slots:
          Id: path.Id
      - text: Show page {page} of user {Id}'s group memberships.
        slots:
          page: query.page
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users/self/externaltokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List my own external tokens
      effect: read
      questions:
      - What external tokens are registered on my own transfer account?
      - Can I sort my registered external tokens?
      instructions:
      - text: List the external tokens on my account.
      - text: Show my external tokens sorted by {sortField}.
        slots:
          sortField: query.sortField
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users/self/externaltokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an external token on my account
      effect: write
      questions:
      - How do I register an external token with my own transfer account?
      - Can I check whether a token would be accepted without actually registering it?
      instructions:
      - text: Register external token {token} of type {type} on my account.
        slots:
          token: requestBody.token
          type: requestBody.type
      - text: Just check whether token {token} would be accepted, check {check}.
        slots:
          token: requestBody.token
          check: requestBody.check
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users/self/externaltokens'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove my external token by its token string
      effect: destructive
      questions:
      - How do I remove one of my external tokens when I only have the encoded token string?
      - Can I unregister my own token by its value instead of its ID?
      instructions:
      - text: Delete my external token whose value is {token}.
        slots:
          token: requestBody.token
      - text: Unregister my {type} token using the token string {token}.
        slots:
          type: requestBody.type
          token: requestBody.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users/{Id}/externaltokens'].get
  update:
    x-apievangelist-phrasing:
      intent: List another user's external tokens
      effect: read
      questions:
      - Which external tokens has a specific transfer user registered?
      - As an admin, can I audit a user's external tokens?
      instructions:
      - text: List the external tokens for transfer user {Id}.
        slots:
          Id: path.Id
      - text: Show user {Id}'s external tokens, page {page}.
        slots:
          Id: path.Id
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users'].get
  update:
    x-apievangelist-phrasing:
      intent: Search transfer user accounts
      effect: read
      questions:
      - How do I find a transfer user by email or username?
      - Can I list only the transfer users with a given permission level or status?
      - Which users belong to a particular organization on the transfer server?
      instructions:
      - text: Find the transfer user with email {email}.
        slots:
          email: query.email
      - text: List transfer users with permission {permission} and status {status}.
        slots:
          permission: query.permission
          status: query.status
      - text: List all transfer users in organization {orgId}.
        slots:
          orgId: query.orgId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or clone a transfer user
      effect: write
      questions:
      - How do I create a new file transfer user with a home folder?
      - Can I create a user by cloning the settings of an existing one?
      instructions:
      - text: Create transfer user {username} for {fullName} with email {email}.
        slots:
          username: requestBody.username
          fullName: requestBody.fullName
          email: requestBody.email
      - text: Clone transfer user {sourceUserId} into a new account {username}.
        slots:
          sourceUserId: requestBody.sourceUserId
          username: requestBody.username
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users/self/externaltokens/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove my external token by its ID
      effect: destructive
      questions:
      - How do I revoke one of my own external tokens using its token ID?
      - Can I delete a specific token from my account if I know its ID?
      instructions:
      - text: Delete my external token with ID {Id}.
        slots:
          Id: path.Id
      - text: Revoke token {Id} from my own account.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/users/{UserId}/externaltokens/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove another user's external token
      effect: destructive
      questions:
      - As an admin, how do I revoke an external token belonging to another user?
      - Can I delete a specific token from someone else's transfer account?
      instructions:
      - text: Delete external token {Id} from user {UserId}.
        slots:
          Id: path.Id
          UserId: path.UserId
      - text: Revoke user {UserId}'s token {Id}.
        slots:
          UserId: path.UserId
          Id: path.Id
      method: generated
      generated: '2026-10-01'