Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga User API

19 actions 19 updates phrasing extends openapi/conga-user-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 19 · first 16 shown; the file carries all of them

$.info

$.paths['/api/review/v1/office365/active-directory-users'].get

$.paths['/api/review/v1/{reviewtype}/reviewers/query'].get

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

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

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

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

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

$.paths['/api/user-management/v1/user/object-access/users'].get

$.paths['/api/user-management/v1/user/objects/actionpermissions'].post

$.paths['/api/user-management/v1/user/objects/{objectName}/actionpermissions'].get

$.paths['/api/user-management/v1/user/objects/{objectName}/field-permissions'].get

$.paths['/api/user-management/v1/user/objects/{objectName}/field-permissions/fields/{fieldName}'].get

$.paths['/api/user-management/v1/user/objects/{objectName}/property-permissions/{propertyName}/{actionName}'].get

$.paths['/api/user-management/v1/user/objects/{objectName}/recordtypes'].get

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

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 Conga User API
  version: 1.0.0
extends: openapi/conga-user-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: 18
- target: $.paths['/api/review/v1/office365/active-directory-users'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Office 365 Active Directory users
      effect: read
      questions:
      - Can I look up people in our Office 365 Active Directory to add as reviewers?
      - Is there a way to find Azure AD users by name from inside Conga Review?
      instructions:
      - text: Find Office 365 directory users matching {searchText}.
        slots:
          searchText: query.searchText
      - text: Search Active Directory for {searchText} using external token {ExternalToken}.
        slots:
          searchText: query.searchText
          ExternalToken: header.ExternalToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/review/v1/{reviewtype}/reviewers/query'].get
  update:
    x-apievangelist-phrasing:
      intent: Search for reviewers by review type
      effect: read
      questions:
      - Which users can I pick as reviewers for a given review type?
      - Does the reviewer search require a search string?
      instructions:
      - text: Search reviewers for review type {reviewtype} matching {searchText}.
        slots:
          reviewtype: path.reviewtype
          searchText: query.searchText
      - text: Find {reviewtype} reviewers named {searchText} with token {ExternalToken}.
        slots:
          reviewtype: path.reviewtype
          searchText: query.searchText
          ExternalToken: header.ExternalToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/actionpermissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all my object action permissions
      effect: read
      questions:
      - What actions am I allowed to perform across all objects?
      - Can I get every object action permission granted to my own login?
      instructions:
      - text: List every object action permission I have.
      - text: Show all the create, edit and delete rights on my account across objects.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/currency'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my user currency
      effect: read
      questions:
      - Which currency is set for my logged-in user?
      - What's my default currency in Conga?
      instructions:
      - text: Tell me which currency my account uses.
      - text: Get the currency code for the current user.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/currency-format'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my currency display format
      effect: read
      questions:
      - How are positive and negative amounts formatted for my user?
      - What currency display format applies to the signed-in user?
      instructions:
      - text: Show my currency formatting settings.
      - text: Get how money values are displayed for the current user.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my signed-in user profile
      effect: read
      questions:
      - Who am I logged in as, and what's on my user profile?
      - If my locale isn't set personally, does my profile fall back to the organization defaults?
      instructions:
      - text: Show the profile information for the user I'm logged in as.
      - text: Get my current user info from user management.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/locale'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my locale settings
      effect: read
      questions:
      - What locale is configured for my user account?
      - Which regional locale does Conga apply when I'm signed in?
      instructions:
      - text: Get my locale settings.
      - text: Tell me the locale assigned to the current user.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/object-access/users'].get
  update:
    x-apievangelist-phrasing:
      intent: Find users with full access to objects
      effect: read
      questions:
      - Which users have full access to a set of objects?
      - Who can fully manage both the Agreement and Quote objects?
      instructions:
      - text: List users with full access on objects {objectNames}.
        slots:
          objectNames: query.objectNames
      - text: Find everyone who has complete rights to {objectNames}.
        slots:
          objectNames: query.objectNames
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/objects/actionpermissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Check my action permissions on several objects
      effect: read
      questions:
      - Can I check my action permissions on several objects in a single request?
      - Is there a bulk lookup of what I can do on a list of object names?
      instructions:
      - text: Check my action permissions for this list of objects in one call.
      - text: Bulk-fetch the actions I'm allowed on each of these object names.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/objects/{objectName}/actionpermissions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my action permissions on one object
      effect: read
      questions:
      - What actions can I take on one specific object type?
      - Am I allowed to delete records of a single given object?
      instructions:
      - text: Show my action permissions on object {objectName}.
        slots:
          objectName: path.objectName
      - text: Get my allowed actions on {objectName} records.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/objects/{objectName}/field-permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my field permissions on an object
      effect: read
      questions:
      - Which fields on an object can I read or edit?
      - How do I see field-level security for every field of one object?
      instructions:
      - text: List my field permissions for all fields on {objectName}.
        slots:
          objectName: path.objectName
      - text: Show field-level access on object {objectName}.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/objects/{objectName}/field-permissions/fields/{fieldName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my permission on one field
      effect: read
      questions:
      - Can I edit one particular field on an object?
      - What access do I have to a single named field?
      instructions:
      - text: Check my permission on field {fieldName} of {objectName}.
        slots:
          fieldName: path.fieldName
          objectName: path.objectName
      - text: Get field-level access for {objectName}.{fieldName} only.
        slots:
          objectName: path.objectName
          fieldName: path.fieldName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/objects/{objectName}/property-permissions/{propertyName}/{actionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: List property values I can access for an action
      effect: read
      questions:
      - Which values of a property am I allowed to use for a given action on an object?
      - Can I see the picklist values I'm permitted to read on a property?
      instructions:
      - text: List the {propertyName} values I can {actionName} on {objectName}.
        slots:
          propertyName: path.propertyName
          actionName: path.actionName
          objectName: path.objectName
      - text: Get accessible values of property {propertyName} on object {objectName} for action {actionName}.
        slots:
          propertyName: path.propertyName
          objectName: path.objectName
          actionName: path.actionName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/objects/{objectName}/recordtypes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my record type permissions on an object
      effect: read
      questions:
      - Which record types of an object am I allowed to use?
      - What record type access do I have on one object?
      instructions:
      - text: Show my record type permissions on {objectName}.
        slots:
          objectName: path.objectName
      - text: List the record types I can access for object {objectName}.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/timezone'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my time zone
      effect: read
      questions:
      - What time zone is my user account set to?
      - Which time zone does Conga use for my dates?
      instructions:
      - text: Get my user time zone.
      - text: Tell me the time zone configured for the current user.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user/{userId}/ui-settings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Toggle a user's next-gen UI setting
      effect: write
      questions:
      - How do I turn on the next-generation UI for a user?
      - Can I switch a user back to the classic interface?
      instructions:
      - text: Set next-gen UI enabled to {IsNextGenUiEnabled} for user {userId}.
        slots:
          IsNextGenUiEnabled: requestBody.IsNextGenUiEnabled
          userId: path.userId
      - text: Update the UI settings of user {userId}.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xajs/v1/xAuthor/User/UsersByType'].post
  update:
    x-apievangelist-phrasing:
      intent: List X-Author users by user type
      effect: read
      questions:
      - Can I list X-Author users filtered by user type?
      - How do I page through X-Author users with a search value?
      instructions:
      - text: List X-Author users of type {userType} for org type {OrgType}.
        slots:
          userType: query.userType
          OrgType: header.OrgType
      - text: Search X-Author users for {searchVal}, {size} at a time, in org type {OrgType}.
        slots:
          searchVal: requestBody.searchVal
          size: requestBody.size
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/current-user-info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the signed-in X-Author user
      effect: read
      questions:
      - Which user is logged into X-Author right now?
      - Can X-Author tell me my current user details for an org type?
      instructions:
      - text: Get my X-Author current user info for org type {OrgType}.
        slots:
          OrgType: header.OrgType
      - text: Show who is signed in to X-Author.
      method: generated
      generated: '2026-10-01'