Conga

Conga User Admin API

The User Admin API from Conga — 15 operation(s) for user admin.

Documentation GitHub OpenAPI

Business capability

Operations 21

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/user-management/v1/users List users in the organization · Get all users #

Ask an LLM

“Can I list every user in my Conga platform tenant?”

“Which users match a criteria filter, sorted by last name?”

Tell an agent

List all users matching {criteria}.

Show page {pageNumber} of users, {pageSize} per page, sorted by {sortField}.

POST /api/user-management/v1/users Create a single user · Create a user #

Ask an LLM

“How do I add one new user with a name, email and role?”

“Can I set a new user's time zone and currency when I create them?”

Tell an agent

Create a user {FirstName} {LastName} with email {Email}.

Add one new user with username {UserName} and role {Role}.

PATCH /api/user-management/v1/users/bulk Update many existing users at once · Update multiple users #

Ask an LLM

“Can I patch fields on a whole batch of existing users together?”

“Are integration users excluded from bulk user updates?”

Tell an agent

Apply these field changes to the existing users in bulk.

Bulk-update the listed users' details without creating anyone new.

POST /api/user-management/v1/users/bulk Create many new users in one request · Create multiple users #

Ask an LLM

“Can I create a batch of brand-new users in a single call?”

“What happens in bulk creation if one of the users already exists?”

Tell an agent

Create these new users in bulk and return their IDs.

Bulk-create the user accounts in this list, flagging any that already exist.

PUT /api/user-management/v1/users/bulk-upsert Create or update many users asynchronously · Create and update multiple users #

Ask an LLM

“Is there an upsert that updates existing users and creates missing ones in one go?”

“Does the bulk upsert avoid duplicate user records?”

Tell an agent

Upsert this batch of users, updating matches and creating the rest.

Run a bulk user upsert in the background for this list.

PUT /api/user-management/v1/users/bulk-upsert-sync Create or update many users synchronously · Create and update multiple users synchronously #

Ask an LLM

“Can I run a user upsert that waits and returns all IDs in the same response?”

“Which upsert call gives me results synchronously instead of queuing?”

Tell an agent

Synchronously upsert these users and wait for their IDs.

Do a blocking bulk upsert of this user list and return the results now.

GET /api/user-management/v1/users/templates/download Download the CSV template for user upload · Get CSV format for user upload #

Ask an LLM

“Where do I get the CSV template with all user fields for importing users?”

“What columns does the user upload file need?”

Tell an agent

Download the latest user upload CSV template.

Generate the blank user-import spreadsheet with every user field.

POST /api/user-management/v1/users/upload Import users from a CSV file · Upload users #

Ask an LLM

“How do I import users from a CSV file?”

“Does the CSV user import validate rows before creating accounts?”

Tell an agent

Upload {usersDataFile} and create the users in it.

Import user records from the CSV file {usersDataFile}.

GET /api/user-management/v1/users/{integrationUserId}/secret Look up an integration user's client ID · Get integration user's client ID #

Ask an LLM

“Where can I find the OAuth client ID for an integration user?”

“Can I read an integration user's client ID without generating a new secret?”

Tell an agent

Get the client ID for integration user {integrationUserId}.

Look up which client ID belongs to integration user {integrationUserId}.

PATCH /api/user-management/v1/users/{integrationUserId}/secret Generate a client secret for an integration user · Generate integration user secret #

Ask an LLM

“How do I generate a client secret for an integration user?”

“Can I issue fresh client credentials for a service account?”

Tell an agent

Generate a new client secret for integration user {integrationUserId}.

Issue client ID and secret credentials for integration user {integrationUserId}.

DELETE /api/user-management/v1/users/{userId} Deactivate a user · Deactivate a user #

Ask an LLM

“How do I deactivate a user who has left the company?”

“Does removing a user delete them or just deactivate the account?”

Tell an agent destructive · confirm first

Deactivate user {userId}.

Turn off the account for user {userId} so they can no longer sign in.

GET /api/user-management/v1/users/{userId} Get a user's details · Get user details by user ID #

Ask an LLM

“What profile details are stored for a specific user?”

“Can I fetch one user's record by their user ID?”

Tell an agent

Show the details for user {userId}.

Fetch the full profile of user {userId}.

PATCH /api/user-management/v1/users/{userId} Update one user's profile · Update a user #

Ask an LLM

“Can I change a single user's email, role or locale formats?”

“Is there a way to suspend one user by editing their profile?”

Tell an agent

Change user {userId}'s email to {Email}.

Set user {userId} as suspended: {IsSuspended}.

POST /api/user-management/v1/users/{userId}/clone Clone an existing user · Clone a user #

Ask an LLM

“Can I copy an existing user's setup to onboard someone new?”

“Is cloning supported for integration users?”

Tell an agent

Clone user {userId} as new username {UserName}.

Make a copy of user {userId} with external ID {ExternalId}.

DELETE /api/user-management/v1/users/{userId}/permissiongroups Remove permission groups from a user · Delete permission groups from a user #

Ask an LLM

“Can I take a permission group away from a user?”

“What errors come back if a permission group I remove isn't on the user?”

Tell an agent destructive · confirm first

Remove permission groups {PermissionGroupNames} from user {userId}.

Revoke user {userId}'s membership in {PermissionGroupNames}.

PUT /api/user-management/v1/users/{userId}/permissiongroups Add permission groups to a user · Assign permission group to a user #

Ask an LLM

“How do I give a user an extra permission group?”

“Does assigning a permission group replace the user's current groups or append?”

Tell an agent

Add permission groups {PermissionGroupNames} to user {userId}.

Grant user {userId} membership in permission group {PermissionGroupNames}.

PUT /api/user-management/v1/users/{userId}/restore Reactivate a deactivated user · Restore a deactivated user #

Ask an LLM

“Can I bring back a user account that was deactivated?”

“How do I restore access for someone who was turned off by mistake?”

Tell an agent

Restore deactivated user {userId}.

Reactivate the account of user {userId}.

GET /api/user-management/v1/users/{userId}/roles Get a user's role · Get a user's role #

Ask an LLM

“Which role is a particular user assigned?”

“What's the role name on a given user's account?”

Tell an agent

Tell me what role user {userId} has.

Look up the role name assigned to user {userId}.

PUT /api/user-management/v1/users/{userId}/roles/{roleId} Change a user's role · Update a user's role #

Ask an LLM

“Can I move a user to a different role?”

“Which call reassigns someone's role by role ID?”

Tell an agent

Change user {userId}'s role to {roleId}.

Assign role {roleId} to user {userId}, replacing their current role.

GET /api/user-management/v1/users/{userId}/roles/{roleId}/exists Check whether a user holds a role · Check if a user is assigned a role #

Ask an LLM

“Is a specific user assigned a particular role, yes or no?”

“Can I verify a user has an admin role before granting access?”

Tell an agent

Check if user {userId} is assigned role {roleId}.

Confirm whether role {roleId} belongs to user {userId}.

POST /api/user-management/v1/users/{userId}/send-welcome-email Re-send a new user's welcome email · Re-send welcome email to new user #

Ask an LLM

“A new user never got their welcome email with login details; can I send it again?”

“Can I resend login credentials after fixing a user's email address?”

Tell an agent

Re-send the welcome email to user {userId}.

Email the login details again to new user {userId}.

Conga User Admin API

Operations 21

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification