Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Authorization API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/api/esign/v1/authorize/refresh'].post
$.paths['/api/esign/v1/authorize/token'].get
$.paths['/api/review/v1/google/authorize'].post
$.paths['/api/review/v1/{reviewtype}/authorize'].get
$.paths['/api/review/v1/{reviewtype}/delegated/token'].get
$.paths['/api/xauthor/v1/authorization/token-info'].get

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 Conga Authorization API
  version: 1.0.0
extends: openapi/conga-authorization-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: 6
- target: $.paths['/api/esign/v1/authorize/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an eSignature refresh token
      effect: write
      questions:
      - How do I exchange an authentication code for a refresh token for my eSignature provider?
      - Can I get a refresh token for a specific sign provider type?
      instructions:
      - text: Get a refresh token for eSignature provider {signProviderType}.
        slots:
          signProviderType: query.signProviderType
      - text: Exchange my authentication code for an eSignature refresh token.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/authorize/token'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an eSignature access token
      effect: read
      questions:
      - Where do I get an access token for my eSignature service provider in Conga?
      - Which eSignature provider types can I request an access token for?
      instructions:
      - text: Retrieve an access token for the {signProviderType} eSignature provider.
        slots:
          signProviderType: query.signProviderType
      - text: Fetch a current eSignature access token.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/review/v1/google/authorize'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a token for a Google service account
      effect: write
      questions:
      - How do I turn my encrypted Google service account JSON into an access token for document review?
      - Can the review service decrypt my Google service account credentials and hand back a token?
      instructions:
      - text: Generate a review access token from my encrypted Google service account JSON.
      - text: Authorize the Google service account flow and return the token.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/review/v1/{reviewtype}/authorize'].get
  update:
    x-apievangelist-phrasing:
      intent: Get review auth URL or token for a user
      effect: read
      questions:
      - How do I get the authorization URL for Office365 document review?
      - Does the review authorize endpoint return a URL or a token, depending on admin settings?
      instructions:
      - text: Get the user profile authorization for review type {reviewtype}.
        slots:
          reviewtype: path.reviewtype
      - text: Get the {reviewtype} review auth URL with state {state}.
        slots:
          reviewtype: path.reviewtype
          state: query.state
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/review/v1/{reviewtype}/delegated/token'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a review token in delegated flow
      effect: read
      questions:
      - How do I swap the auth code from the delegated login for a review token?
      - What do I need to finish the delegated authorization flow for Office365 review?
      instructions:
      - text: Exchange auth code {code} for a {reviewtype} delegated review token.
        slots:
          code: query.code
          reviewtype: path.reviewtype
      - text: Complete the delegated flow for review type {reviewtype}.
        slots:
          reviewtype: path.reviewtype
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/authorization/token-info'].get
  update:
    x-apievangelist-phrasing:
      intent: Check who a login token belongs to
      effect: read
      questions:
      - How can I verify whether my logged-in token is valid on the Conga Platform or Salesforce?
      - What information does the X-Author token info check return about the user?
      instructions:
      - text: Verify my X-Author login token for org type {OrgType}.
        slots:
          OrgType: header.OrgType
      - text: Show the token info for my current X-Author session.
      method: generated
      generated: '2026-10-01'