Jitterbit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harmony API Reference Login API

3 actions 3 updates phrasing extends openapi/jitterbit-login-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Jitterbit's API. It is a proposal applied on top of the contract, not a document Jitterbit publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/login'].get
$.paths['/login'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harmony API Reference Login API
  version: 1.0.0
extends: openapi/jitterbit-login-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/login'].get
  update:
    x-apievangelist-phrasing:
      intent: Exchange an auth token for a JWT
      effect: read
      questions:
      - Can I turn my Harmony auth token into a JSON Web Token?
      - Which endpoint swaps an existing login token for a JWT?
      instructions:
      - text: Convert auth token {authToken} into a JWT.
        slots:
          authToken: header.authToken
      - text: Get the JWT associated with my active token {authToken}.
        slots:
          authToken: header.authToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/login'].post
  update:
    x-apievangelist-phrasing:
      intent: Log in and get a Harmony auth token
      effect: write
      questions:
      - How do I get an auth token for the Jitterbit Harmony API with my username and password?
      - Can I sign in to the Harmony API if my organization uses single sign-on?
      - What credentials do I send in the headers to log in to Harmony?
      instructions:
      - text: Log in to Harmony as {username} with password {password} and give me the auth token.
        slots:
          username: header.username
          password: header.password
      - text: Authenticate my Harmony account {username} so I can call the other APIs.
        slots:
          username: header.username
      method: generated
      generated: '2026-09-26'