# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for MOVEit Transfer REST Security Settings API
  version: 1.0.0
extends: openapi/progress-software-security-settings-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: 12
- target: $.paths['/api/v1/settings/security/ipwhitelist'].get
  update:
    x-apievangelist-phrasing:
      intent: List IP whitelist entries
      effect: read
      questions:
      - Which IP addresses are on my organization's whitelist?
      - Can I sort the IP allow list entries?
      instructions:
      - text: List all IP whitelist entries.
      - text: List IP whitelist entries sorted by {sortField}.
        slots:
          sortField: query.sortField
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/settings/security/ipwhitelist'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an IP whitelist entry
      effect: write
      questions:
      - How do I allow a new IP address through the whitelist?
      - Can I add a comment explaining why an IP is whitelisted?
      instructions:
      - text: Whitelist IP {ipAddress}.
        slots:
          ipAddress: requestBody.ipAddress
      - text: Add {ipAddress} to the IP whitelist with comment {comment}.
        slots:
          ipAddress: requestBody.ipAddress
          comment: requestBody.comment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/settings/security/password/aging/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List password aging policies
      effect: read
      questions:
      - What password aging policies are defined?
      - Can I page through the available password expiry policies?
      instructions:
      - text: List password aging policies.
      - text: Show page {page} of password aging policies.
        slots:
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/settings/security/password/aging/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a password aging policy
      effect: write
      questions:
      - How do I make passwords expire after a set time?
      - Can a password aging policy include a warning period and grace period?
      instructions:
      - text: Create password aging policy {name} expiring after {passwordAgeTime}.
        slots:
          name: requestBody.name
          passwordAgeTime: requestBody.passwordAgeTime
      - text: Create policy {name} with a {passwordAgeWarn} warning and {passwordAgeGrace} grace period.
        slots:
          name: requestBody.name
          passwordAgeWarn: requestBody.passwordAgeWarn
          passwordAgeGrace: requestBody.passwordAgeGrace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/settings/security/userauth/expiration/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List user auth expiration policies
      effect: read
      questions:
      - What account expiration policies exist for users?
      - Which user auth expiration policies can I assign?
      instructions:
      - text: List user auth expiration policies.
      - text: List user expiration policies sorted by {sortField}.
        slots:
          sortField: query.sortField
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/settings/security/userauth/expiration/policies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user auth expiration policy
      effect: write
      questions:
      - How do I make user accounts expire after inactivity?
      - Can accounts expire after a fixed number of sign-ons?
      instructions:
      - text: Create expiration policy {name} that expires accounts on {expireDate}.
        slots:
          name: requestBody.name
          expireDate: requestBody.expireDate
      - text: Create policy {name} expiring users after {activityExpireTime} of inactivity.
        slots:
          name: requestBody.name
          activityExpireTime: requestBody.activityExpireTime
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/settings/security/ipwhitelist/{entryId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an IP whitelist entry
      effect: write
      questions:
      - Can I change the IP address on an existing whitelist entry?
      - How do I edit the comment of a whitelisted IP?
      instructions:
      - text: Change whitelist entry {entryId} to IP {ipAddress}.
        slots:
          entryId: path.entryId
          ipAddress: requestBody.ipAddress
      - text: Update the comment on whitelist entry {entryId} to {comment}.
        slots:
          entryId: path.entryId
          comment: requestBody.comment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/settings/security/ipwhitelist/{entryId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an IP whitelist entry
      effect: destructive
      questions:
      - How do I take an IP off the whitelist?
      - Can I delete a stale allow-list entry?
      instructions:
      - text: Remove IP whitelist entry {entryId}.
        slots:
          entryId: path.entryId
      - text: Delete whitelist entry {entryId}.
        slots:
          entryId: path.entryId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/settings/security/remoteaccess/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a default remote access rule
      effect: write
      questions:
      - How do I allow or deny remote access from a specific host?
      - Can I set the priority of a remote access rule?
      instructions:
      - text: Create a remote access rule to {permitType} host {host}.
        slots:
          permitType: requestBody.permitType
          host: requestBody.host
      - text: Add a {permitType} rule for {host} at priority {priority}.
        slots:
          permitType: requestBody.permitType
          host: requestBody.host
          priority: requestBody.priority
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/settings/security/password/permissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Update password permission settings
      effect: write
      questions:
      - Can users be allowed to change their own passwords?
      - How do I require reCAPTCHA or security questions for password change requests?
      instructions:
      - text: 'Allow users to change their own password: {allowToChangeOwnPassword}.'
        slots:
          allowToChangeOwnPassword: requestBody.allowToChangeOwnPassword
      - text: Set the password email link max age to {passwordEmailLinkMaxAge}.
        slots:
          passwordEmailLinkMaxAge: requestBody.passwordEmailLinkMaxAge
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/settings/security/password/aging'].patch
  update:
    x-apievangelist-phrasing:
      intent: Assign the account password aging policy
      effect: write
      questions:
      - Which password aging policy applies to users, and can I switch it?
      - Can I apply a new password aging policy to existing users too?
      instructions:
      - text: Use password aging policy {policyId} for {userPermission} users.
        slots:
          policyId: requestBody.policyId
          userPermission: requestBody.userPermission
      - text: Apply password aging policy {policyId} to existing users.
        slots:
          policyId: requestBody.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/settings/security/userauth/expiration'].patch
  update:
    x-apievangelist-phrasing:
      intent: Assign the account auth expiration policy
      effect: write
      questions:
      - How do I set which account expiration policy users get?
      - Can a user expiration policy be applied retroactively to existing users?
      instructions:
      - text: Use auth expiration policy {policyId} for {userPermission} users.
        slots:
          policyId: requestBody.policyId
          userPermission: requestBody.userPermission
      - text: Apply user expiration policy {policyId} to existing users.
        slots:
          policyId: requestBody.policyId
      method: generated
      generated: '2026-10-01'