Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for User Management API Connections API

6 actions 6 updates phrasing extends openapi/conga-api-connections-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 6

$.info

$.paths['/api/user-management/v1/api-connections'].get

$.paths['/api/user-management/v1/api-connections/{externalIdentifier}'].get

$.paths['/api/user-management/v1/api-connections/{externalIdentifier}'].put

$.paths['/api/user-management/v1/api-connections/{externalIdentifier}'].post

$.paths['/api/user-management/v1/api-connections/{externalIdentifier}/status'].put

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 User Management API Connections API
  version: 1.0.0
extends: openapi/conga-api-connections-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/user-management/v1/api-connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List all API connections
      effect: read
      questions:
      - Which API connections and clients are set up for our tenant?
      - Can I sort and page the list of API connections?
      instructions:
      - text: List all API connections.
      - text: Show API connections sorted by {sortField}, page {pageNumber}.
        slots:
          sortField: query.sortField
          pageNumber: query.pageNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/api-connections/{externalIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API connection
      effect: read
      questions:
      - What are the settings of a particular API connection?
      - Can I look up an API connection by its external identifier and type?
      instructions:
      - text: Get API connection {externalIdentifier}.
        slots:
          externalIdentifier: path.externalIdentifier
      - text: Show the {apiConnectionType} connection {externalIdentifier}.
        slots:
          apiConnectionType: query.apiConnectionType
          externalIdentifier: path.externalIdentifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/api-connections/{externalIdentifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an API connection's settings
      effect: write
      questions:
      - How do I change the redirect URI on an existing API connection?
      - Can I update allowed scopes or CORS origins for an API client?
      instructions:
      - text: Set redirect URI {RedirectURI} on API connection {externalIdentifier}.
        slots:
          RedirectURI: requestBody.RedirectURI
          externalIdentifier: path.externalIdentifier
      - text: Update allowed scopes for API connection {externalIdentifier} to {AllowedScopes}.
        slots:
          externalIdentifier: path.externalIdentifier
          AllowedScopes: requestBody.AllowedScopes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/api-connections/{externalIdentifier}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an API connection
      effect: write
      questions:
      - How do I register a new API client connection?
      - What do I need to provide, such as client name and redirect URI, to add an API connection?
      instructions:
      - text: Add API connection {externalIdentifier} for client {ClientName}.
        slots:
          externalIdentifier: path.externalIdentifier
          ClientName: requestBody.ClientName
      - text: Register new {apiConnectionType} connection {externalIdentifier} with redirect URI {RedirectURI}.
        slots:
          apiConnectionType: query.apiConnectionType
          externalIdentifier: path.externalIdentifier
          RedirectURI: requestBody.RedirectURI
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/api-connections/{externalIdentifier}/status'].put
  update:
    x-apievangelist-phrasing:
      intent: Activate or deactivate an API connection
      effect: write
      questions:
      - Can I disable an API connection without deleting it?
      - How do I turn an inactive API connection back on?
      instructions:
      - text: Deactivate API connection {externalIdentifier}.
        slots:
          externalIdentifier: path.externalIdentifier
      - text: Set API connection {externalIdentifier} active status to {IsActive}.
        slots:
          externalIdentifier: path.externalIdentifier
          IsActive: requestBody.IsActive
      method: generated
      generated: '2026-10-01'