Operations 18
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
GET
/api/review/v1/office365/active-directory-users
Search Office 365 Active Directory users · Gets existing users from search text
#
Ask an LLM
“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?”
Tell an agent
Find Office 365 directory users matching {searchText}.
Search Active Directory for {searchText} using external token {ExternalToken}.
GET
/api/review/v1/{reviewtype}/reviewers/query
Search for reviewers by review type · Search users
#
Ask an LLM
“Which users can I pick as reviewers for a given review type?”
“Does the reviewer search require a search string?”
Tell an agent
Search reviewers for review type {reviewtype} matching {searchText}.
Find {reviewtype} reviewers named {searchText} with token {ExternalToken}.
GET
/api/user-management/v1/user/actionpermissions
List all my object action permissions · Get all action permissions for the current user
#
Ask an LLM
“What actions am I allowed to perform across all objects?”
“Can I get every object action permission granted to my own login?”
Tell an agent
List every object action permission I have.
Show all the create, edit and delete rights on my account across objects.
Ask an LLM
“Which currency is set for my logged-in user?”
“What's my default currency in Conga?”
Tell an agent
Tell me which currency my account uses.
Get the currency code for the current user.
GET
/api/user-management/v1/user/currency-format
Get my currency display format · Get logged-in user's currency format
#
Ask an LLM
“How are positive and negative amounts formatted for my user?”
“What currency display format applies to the signed-in user?”
Tell an agent
Show my currency formatting settings.
Get how money values are displayed for the current user.
GET
/api/user-management/v1/user/info
Get my signed-in user profile · Get logged-in user information
#
Ask an LLM
“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?”
Tell an agent
Show the profile information for the user I'm logged in as.
Get my current user info from user management.
Ask an LLM
“What locale is configured for my user account?”
“Which regional locale does Conga apply when I'm signed in?”
Tell an agent
Get my locale settings.
Tell me the locale assigned to the current user.
GET
/api/user-management/v1/user/object-access/users
Find users with full access to objects · Get users with full access on given objects
#
Ask an LLM
“Which users have full access to a set of objects?”
“Who can fully manage both the Agreement and Quote objects?”
Tell an agent
List users with full access on objects {objectNames}.
Find everyone who has complete rights to {objectNames}.
POST
/api/user-management/v1/user/objects/actionpermissions
Check my action permissions on several objects · Get bulk action permissions
#
Ask an LLM
“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?”
Tell an agent
Check my action permissions for this list of objects in one call.
Bulk-fetch the actions I'm allowed on each of these object names.
GET
/api/user-management/v1/user/objects/{objectName}/actionpermissions
Get my action permissions on one object · Get action permissions by object name
#
Ask an LLM
“What actions can I take on one specific object type?”
“Am I allowed to delete records of a single given object?”
Tell an agent
Show my action permissions on object {objectName}.
Get my allowed actions on {objectName} records.
GET
/api/user-management/v1/user/objects/{objectName}/field-permissions
Get my field permissions on an object · Get field permission details by object name
#
Ask an LLM
“Which fields on an object can I read or edit?”
“How do I see field-level security for every field of one object?”
Tell an agent
List my field permissions for all fields on {objectName}.
Show field-level access on object {objectName}.
GET
/api/user-management/v1/user/objects/{objectName}/field-permissions/fields/{fieldName}
Get my permission on one field · Get field permission details by field name on given object
#
Ask an LLM
“Can I edit one particular field on an object?”
“What access do I have to a single named field?”
Tell an agent
Check my permission on field {fieldName} of {objectName}.
Get field-level access for {objectName}.{fieldName} only.
GET
/api/user-management/v1/user/objects/{objectName}/property-permissions/{propertyName}/{actionName}
List property values I can access for an action · Get accessible property values of property object by object name and action type
#
Ask an LLM
“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?”
Tell an agent
List the {propertyName} values I can {actionName} on {objectName}.
Get accessible values of property {propertyName} on object {objectName} for action {actionName}.
GET
/api/user-management/v1/user/objects/{objectName}/recordtypes
Get my record type permissions on an object · Get record type permission details by object name
#
Ask an LLM
“Which record types of an object am I allowed to use?”
“What record type access do I have on one object?”
Tell an agent
Show my record type permissions on {objectName}.
List the record types I can access for object {objectName}.
Ask an LLM
“What time zone is my user account set to?”
“Which time zone does Conga use for my dates?”
Tell an agent
Get my user time zone.
Tell me the time zone configured for the current user.
PATCH
/api/user-management/v1/user/{userId}/ui-settings
Toggle a user's next-gen UI setting · Update a user's UI settings
#
Ask an LLM
“How do I turn on the next-generation UI for a user?”
“Can I switch a user back to the classic interface?”
Tell an agent
Set next-gen UI enabled to {IsNextGenUiEnabled} for user {userId}.
Update the UI settings of user {userId}.
POST
/api/xajs/v1/xAuthor/User/UsersByType
List X-Author users by user type · Create api xajs x author user users by type
#
Ask an LLM
“Can I list X-Author users filtered by user type?”
“How do I page through X-Author users with a search value?”
Tell an agent
List X-Author users of type {userType} for org type {OrgType}.
Search X-Author users for {searchVal}, {size} at a time, in org type {OrgType}.
Documentation
Authentication
https://artifacts.apis.io/conga/authentication/conga-authentication.yml
RateLimits
https://artifacts.apis.io/conga/rate-limits/conga-rate-limits.yml
Specifications
Other Resources
DataModel
https://artifacts.apis.io/conga/data-model/conga-data-model.yml
OAuthScopes
https://artifacts.apis.io/conga/scopes/conga-scopes.yml
Conventions
https://artifacts.apis.io/conga/conventions/conga-conventions.yml
ErrorCatalog
https://artifacts.apis.io/conga/errors/conga-problem-types.yml
Lifecycle
https://artifacts.apis.io/conga/lifecycle/conga-lifecycle.yml
Conformance
https://artifacts.apis.io/conga/conformance/conga-conformance.yml
Sandbox
https://artifacts.apis.io/conga/sandbox/conga-sandbox.yml
Webhooks
https://artifacts.apis.io/conga/asyncapi/conga-webhooks.yml