# 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 Organizations API
  version: 1.0.0
extends: openapi/progress-software-organizations-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: 8
- target: $.paths['/api/v1/organizations/{OrgId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's details
      effect: read
      questions:
      - How do I see the full settings of one organization on the transfer server?
      - What details come back for an organization by ID?
      instructions:
      - text: Show organization {OrgId}.
        slots:
          OrgId: path.OrgId
      - text: Get the detailed info for org {OrgId}.
        slots:
          OrgId: path.OrgId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizations
      effect: read
      questions:
      - Which organizations exist on the transfer server?
      - Can I sort the organization list by a field?
      instructions:
      - text: List all organizations.
      - text: Show organizations sorted by {sortField} {sortDirection}.
        slots:
          sortField: query.sortField
          sortDirection: query.sortDirection
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization
      effect: write
      questions:
      - How do I create a new organization with its own passphrase?
      - Can I set a technical contact when creating an organization?
      instructions:
      - text: Create organization {name} with passphrase {passPhrase}.
        slots:
          name: requestBody.name
          passPhrase: requestBody.passPhrase
      - text: Create org {name} with passphrase {passPhrase} and tech contact {techEmail}.
        slots:
          name: requestBody.name
          passPhrase: requestBody.passPhrase
          techEmail: requestBody.techEmail
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations/{orgId}/maxusercounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Set an organization's maximum user counts
      effect: write
      questions:
      - How do I cap the number of users an organization can have?
      - Can I set separate limits for end users and temporary users?
      instructions:
      - text: Limit organization {orgId} to {totalUsers} total users.
        slots:
          orgId: path.orgId
          totalUsers: requestBody.totalUsers
      - text: Set org {orgId}'s max end users to {endUsers} and temp users to {tempUsers}.
        slots:
          orgId: path.orgId
          endUsers: requestBody.endUsers
          tempUsers: requestBody.tempUsers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations/{orgId}/packageaccess'].post
  update:
    x-apievangelist-phrasing:
      intent: Set administrator package access for an org
      effect: write
      questions:
      - Can administrators read users' packages in an organization, and how do I change that?
      - How do I show ad hoc transfer entries in the organization's log?
      instructions:
      - text: Set admin package access for org {orgId} to {adminPackageAccess}.
        slots:
          orgId: path.orgId
          adminPackageAccess: requestBody.adminPackageAccess
      - text: 'Show ad hoc transfer entries in the log for org {orgId}: {showAdHocTransferEntriesInLog}.'
        slots:
          orgId: path.orgId
          showAdHocTransferEntriesInLog: requestBody.showAdHocTransferEntriesInLog
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations/{orgId}/passwordreset'].post
  update:
    x-apievangelist-phrasing:
      intent: Toggle admin password reset for an org
      effect: write
      questions:
      - How do I let administrators reset their own passwords in an organization?
      - Can I turn off admin password reset for one org?
      instructions:
      - text: 'Enable admin password reset for org {orgId}: {enableAdminPasswordReset}.'
        slots:
          orgId: path.orgId
          enableAdminPasswordReset: requestBody.enableAdminPasswordReset
      - text: Turn off administrator password reset in organization {orgId}.
        slots:
          orgId: path.orgId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations/{orgId}/interfaceconfiguration'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure which UI features an org shows
      effect: write
      questions:
      - How do I hide files and folders from users in an organization's web interface?
      - Can I turn ad hoc packages or secure folder sharing on or off for an org?
      instructions:
      - text: 'Show files and folders in org {orgId}''s interface: {showFileAndFolder}.'
        slots:
          orgId: path.orgId
          showFileAndFolder: requestBody.showFileAndFolder
      - text: Set secure folder sharing visibility for org {orgId} to {showSecureFolderSharing}.
        slots:
          orgId: path.orgId
          showSecureFolderSharing: requestBody.showSecureFolderSharing
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations/{orgId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an organization's general info
      effect: write
      questions:
      - How do I rename an organization or change its short name?
      - Can I update an organization's base URL?
      instructions:
      - text: Rename organization {orgId} to {name}.
        slots:
          orgId: path.orgId
          name: requestBody.name
      - text: Set org {orgId}'s base URL to {baseUrl}.
        slots:
          orgId: path.orgId
          baseUrl: requestBody.baseUrl
      method: generated
      generated: '2026-10-01'