Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for MOVEit Transfer REST Authentication API

6 actions 6 updates phrasing extends openapi/progress-software-authentication-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Progress Software's API. It is a proposal applied on top of the contract, not a document Progress Software publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/api/v1/auth/identityproviders'].get

$.paths['/api/v1/auth/actasadmin'].post

$.paths['/api/v1/token'].post

$.paths['/api/v1/token/revoke'].post

$.paths['/api/v1/token/otp'].post

OpenAPI Overlay

# 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 Authentication API
  version: 1.0.0
extends: openapi/progress-software-authentication-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: 5
- target: $.paths['/api/v1/auth/identityproviders'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity providers
      effect: read
      questions:
      - Which identity providers are configured for my organization?
      - Can I see the SSO providers for a specific org?
      instructions:
      - text: List identity providers for organization {orgId}.
        slots:
          orgId: query.orgId
      - text: List all configured identity providers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/auth/actasadmin'].post
  update:
    x-apievangelist-phrasing:
      intent: Act as administrator in an organization
      effect: write
      questions:
      - How can a sysadmin act as administrator in a specific organization?
      - Can I switch into another org's admin context?
      instructions:
      - text: Act as administrator in organization {orgId}.
        slots:
          orgId: requestBody.orgId
      - text: Become admin of org {orgId}.
        slots:
          orgId: requestBody.orgId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an API access token
      effect: write
      questions:
      - How do I sign in and get an API token with a username and password?
      - Can I refresh an expired access token?
      - Does token retrieval support MFA one-time passwords?
      instructions:
      - text: Get an access token for {username} using grant type {grant_type}.
        slots:
          username: requestBody.username
          grant_type: requestBody.grant_type
      - text: Refresh my session with refresh token {refresh_token}.
        slots:
          refresh_token: requestBody.refresh_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/token/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke an API token
      effect: destructive
      questions:
      - How do I log out by revoking my API token?
      - Can I invalidate a token so it can't be used again?
      instructions:
      - text: Revoke token {token}.
        slots:
          token: requestBody.token
      - text: Invalidate API token {token}.
        slots:
          token: requestBody.token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/token/otp'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a one-time password
      effect: write
      questions:
      - How do I get a one-time password sent during MFA sign-in?
      - Can I resend an OTP for multi-factor login?
      instructions:
      - text: Send a one-time password for MFA token {mfa_access_token}.
        slots:
          mfa_access_token: requestBody.mfa_access_token
      - text: Resend the OTP for MFA session {mfa_access_token}.
        slots:
          mfa_access_token: requestBody.mfa_access_token
      method: generated
      generated: '2026-10-01'