Conga

Conga User Admin API

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

Documentation GitHub OpenAPI

Business capability

Identity & Access Management BC-620.20

Operations 21

GET /api/user-management/v1/users Get all users

POST /api/user-management/v1/users Create a user

PATCH /api/user-management/v1/users/bulk Update multiple users

POST /api/user-management/v1/users/bulk Create multiple users

PUT /api/user-management/v1/users/bulk-upsert Create and update multiple users

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

GET /api/user-management/v1/users/templates/download Get CSV format for user upload

POST /api/user-management/v1/users/upload Upload users

GET /api/user-management/v1/users/{integrationUserId}/secret Get integration user's client ID

PATCH /api/user-management/v1/users/{integrationUserId}/secret Generate integration user secret

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

GET /api/user-management/v1/users/{userId} Get user details by user ID

PATCH /api/user-management/v1/users/{userId} Update a user

POST /api/user-management/v1/users/{userId}/clone Clone a user

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

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

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

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

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

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

POST /api/user-management/v1/users/{userId}/send-welcome-email Re-send welcome email to new user

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/conga-user-admin-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: User Management User Admin API
  version: v1
servers:
- url: https://rls.congacloud.com
security:
- Bearer: []
tags:
- name: User Admin
paths:
  /api/user-management/v1/users:
    get:
      tags:
      - User Admin
      summary: Get all users
      description: Returns all users that meet the criteria.
      parameters:
      - name: criteria
        in: query
        description: 'Search criteria for the users. **For example**: IsActive = ''true''. <p>**Note**: The criteria field (in this case, IsActive) should be indexed.</p>'
        schema:
          type: string
      - name: sortField
        in: query
        description: 'Field name for sorting. **For example**: FirstName. <p>**Note**: The sort field (in this case, FirstName) should be indexed or sortable.</p>'
        schema:
          type: string
      - name: sortDirection
        in: query
        description: 'Sort direction (Ascending or Descending) of the data. For example: ASC or DESC. <p>**Note**: The default sort order is **DESC** if the sort field parameter is specified.</p>'
        schema:
          type: string
      - name: pageSize
        in: query
        description: The number of records to display on each page.
        schema:
          type: integer
          format: int32
      - name: pageNumber
        in: query
        description: The page number of the result set to view.
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringObjectDictionaryListAPIResponse'
              example:
                Success: true
                RecordCount: 2
                Data:
                - UserName: SystemAdmin
                  Id: ba6d40a5-d9c6-46db-ba89-4b3e7b98eb5f
                  PermissionGroups: GlobalScopePermissionGroup
                - UserName: GeneralUser
                  Id: cbe1655c-9475-43da-9e17-ea47aea69ca1
                  PermissionGroups: ScopePermissionGroup
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
    post:
      tags:
      - User Admin
      summary: Create a user
      description: Creates a new user and returns the user's ID.
      requestBody:
        description: User model data to be created
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/UserCreateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UserCreateRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: true
                Data: 1bbb1b9d-9671-43dc-aab5-cc338c1bb6fc
                StatusCode: Created
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
  /api/user-management/v1/users/bulk:
    patch:
      tags:
      - User Admin
      summary: Update multiple users
      description: 'Updates multiple users and returns the updatedUser object. <p>**Note**: Bulk user updation is not supported for the `Integration` user type.</p>'
      requestBody:
        description: Details to be updated in the user model
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkUserUpdateRequest'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkUserUpdateRequest'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkUserUpdateRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponseListAPIResponse'
              example:
                Success: true
                Data:
                - FirstName: Test
                  LastName: user
                  UserName: TestUser
                  Email: systemuser@conga.com
                  Role:
                    Id: dfba608f-bdcb-4197-a772-9651eb2253fa
                    Name: SysAdmin
                  PermissionGroups: ScopePermissionGroup
                  RolePermissionGroups: null
                  Timezone: null
                  Locale: null
                  Currency: null
                  CurrencyFormat: null
                  IsDeleted: false
                  IsActive: true
                  IsSuspended: false
                  Alias: null
                  Language: null
                  SmallPhotoUrl: null
                  LastLoginDate: null
                  Address: 71 ST. NICHOLAS DRIVE
                  PhoneNumber: null
                  IdentityStatus: null
                  UserType: External
                  AdminPermissions: null
                  OrganizationExternalId: null
                  UserGroupsAssignedTo: null
                  Clientid: null
                  FederationId: null
                  IsNextGenUiEnabled: null
                  Id: b693c0c8-a20c-4fc9-aecf-b99f8a955c90
                  Name: Test user
                  CreatedBy:
                    Id: fa11d701-cce7-475f-85bd-1ae9df0a5792
                    Name: System Admin
                  CreatedDate: '2026-07-27T11:07:34.9155611+00:00'
                  ModifiedBy:
                    Id: 2bb7a17b-1d59-4df7-9f24-603677d19678
                    Name: System Admin
                  ModifiedDate: '2026-07-27T11:07:34.9155721+00:00'
                  ExternalId: 002i000002AWbWuGFA
                  ETag: null
                Errors:
                - Message: 'This user doesn''t exist. : UserId - e6fd40f0-bd2d-46e0-aff0-5843707d22c9'
                - Message: 'Pacific/Midway timezone not exist. : UserId - 2c52da29-0c3a-4aa2-ba71-fbc705552f9e'
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
    post:
      tags:
      - User Admin
      summary: Create multiple users
      description: 'Creates multiple users and returns their IDs.<p>**Note**: <ul>If a user already exists, the user ID is returned with a validation error.</ul><ul>Bulk user creation is not supported for the `Integration` user type.</ul></p>'
      requestBody:
        description: Users model data to be created
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserCreateRequest'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserCreateRequest'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserCreateRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: true
                Data: User create request has been processed. Kindly review identity status of user.
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
  /api/user-management/v1/users/bulk-upsert:
    put:
      tags:
      - User Admin
      summary: Create and update multiple users
      description: 'Creates and updates multiple users and returns the IDs of the users. <p>**Note**: If a user already exists (based on a Platform user record identifier), the API will update the existing user instead of creating a duplicate record , else if the user is not present new record is created.</p>'
      requestBody:
        description: Users model data to be created or updated
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserUpsertRequest'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserUpsertRequest'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserUpsertRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringObjectDictionaryAPIResponse'
              example:
                Success: true
                Data:
                  ObjectName: SampleObject
                  PermissionGroupName: ViewAllPermissionGroup
                  Id: 4afa128c-2bad-4f1c-a338-c4e3c7c5ca2a
                  RecordTypeAccess:
                    NDA:
                      Enabled: true
                    MSA:
                      Enabled: false
                    Master:
                      Enabled: true
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
  /api/user-management/v1/users/bulk-upsert-sync:
    put:
      tags:
      - User Admin
      summary: Create and update multiple users synchronously
      description: 'Creates and updates multiple users and returns the IDs of the users synchronously. <p>**Note**: If a user already exists (based on a Platform user record identifier), the API will update the existing user instead of creating a duplicate record , else if the user is not present new record is created.</p>'
      requestBody:
        description: Users model data to be created or updated
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserUpsertRequest'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserUpsertRequest'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UserUpsertRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringObjectDictionaryAPIResponse'
              example:
                Success: true
                Data:
                  ObjectName: SampleObject
                  PermissionGroupName: ViewAllPermissionGroup
                  Id: 73a7342f-7e4e-49a5-81ee-ba829388a782
                  RecordTypeAccess:
                    NDA:
                      Enabled: true
                    MSA:
                      Enabled: false
                    Master:
                      Enabled: true
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
  /api/user-management/v1/users/templates/download:
    get:
      tags:
      - User Admin
      summary: Get CSV format for user upload
      description: Fetches the most recent user metadata, generates a .csv file with all of the user fields, and returns a template for uploading users for download.
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
  /api/user-management/v1/users/upload:
    post:
      tags:
      - User Admin
      summary: Upload users
      description: 'Accepts a .csv file containing user records as input, creates users, and returns the IDs for all newly created users.<p>**Note**: <ul>The system validates the uploaded file first. If the file has any incorrect field names, the validation will fail and an error message will be displayed in the response.</ul><ul>User upload is not supported for the `Integration` user type.</ul></p>'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                usersDataFile:
                  type: string
                  format: binary
            encoding:
              usersDataFile:
                style: form
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: true
                Data: User create request has been processed. Kindly review identity status of user.
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
  /api/user-management/v1/users/{integrationUserId}/secret:
    get:
      tags:
      - User Admin
      summary: Get integration user's client ID
      description: Retrieves integration user's client ID based on the user ID.
      parameters:
      - name: integrationUserId
        in: path
        description: Integration user's ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationUserSecretGetResponseAPIResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
    patch:
      tags:
      - User Admin
      summary: Generate integration user secret
      description: Generates the **Secret** for the provided integration user ID and returns the Client ID and Client Secret.
      parameters:
      - name: integrationUserId
        in: path
        description: Integration user's ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationUserGenerateSecretResponseAPIResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
  /api/user-management/v1/users/{userId}:
    delete:
      tags:
      - User Admin
      summary: Deactivate a user
      description: Deactivates a user and returns status.
      parameters:
      - name: userId
        in: path
        description: User ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: true
                Data: User InActivate request has been processed. Kindly review identity status of user.
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
    get:
      tags:
      - User Admin
      summary: Get user details by user ID
      description: Returns the details of a user based on the user ID.
      parameters:
      - name: userId
        in: path
        description: User ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponseAPIResponse'
              example:
                Success: true
                Data:
                  FirstName: system
                  LastName: user
                  UserName: SystemUser
                  Email: systemuser@conga.com
                  Role:
                    Id: eb63dfe7-6eeb-4332-a8fc-89dd894ed519
                    Name: SysAdmin
                  PermissionGroups: ScopePermissionGroup
                  RolePermissionGroups: null
                  Timezone: null
                  Locale: null
                  Currency: null
                  CurrencyFormat: null
                  IsDeleted: false
                  IsActive: true
                  IsSuspended: null
                  Alias: null
                  Language: null
                  SmallPhotoUrl: null
                  LastLoginDate: null
                  Address: 71 ST. NICHOLAS DRIVE
                  PhoneNumber: null
                  IdentityStatus: null
                  UserType: External
                  AdminPermissions: null
                  OrganizationExternalId: null
                  UserGroupsAssignedTo: null
                  Clientid: null
                  FederationId: null
                  IsNextGenUiEnabled: null
                  Id: null
                  Name: null
                  CreatedBy:
                    Id: 0417dc98-a096-4bea-9c4e-6c4055cf8098
                    Name: System Admin
                  CreatedDate: '2026-07-27T11:07:34.9711124+00:00'
                  ModifiedBy:
                    Id: d5eae47e-e7df-41f5-af1a-ec7a34dd898f
                    Name: System Admin
                  ModifiedDate: '2026-07-27T11:07:34.97112+00:00'
                  ExternalId: null
                  ETag: null
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
    patch:
      tags:
      - User Admin
      summary: Update a user
      description: Updates the user information for a specific user.
      parameters:
      - name: userId
        in: path
        description: User ID
        required: true
        schema:
          type: string
      requestBody:
        description: 'Details to be updated in the user model. **Note**: To see a list of supported numbers, dates, and currency formats, use the *Timezone and Locale APIs* and the *Currency Format APIs*.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserUpdateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/UserUpdateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UserUpdateRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponseAPIResponse'
              example:
                Success: true
                Data:
                  FirstName: system
                  LastName: user
                  UserName: DummySystemUser
                  Email: dummysystemuser@conga.com
                  Role:
                    Id: cbecc3fc-0d00-44f8-a6ea-60cd86657a48
                    Name: SysAdmin
                  PermissionGroups: GlobalScopePermissionGroup
                  RolePermissionGroups: null
                  Timezone: null
                  Locale: null
                  Currency: null
                  CurrencyFormat: null
                  IsDeleted: false
                  IsActive: true
                  IsSuspended: null
                  Alias: null
                  Language: null
                  SmallPhotoUrl: null
                  LastLoginDate: null
                  Address: 1901 W El Los Angeles
                  PhoneNumber: null
                  IdentityStatus: null
                  UserType: External
                  AdminPermissions: null
                  OrganizationExternalId: null
                  UserGroupsAssignedTo: null
                  Clientid: null
                  FederationId: null
                  IsNextGenUiEnabled: null
                  Id: null
                  Name: null
                  CreatedBy:
                    Id: a8095312-65d4-46ac-b254-673f8705e208
                    Name: System Admin
                  CreatedDate: '2026-07-27T11:07:34.9629967+00:00'
                  ModifiedBy:
                    Id: 375e2164-a33f-495e-87b5-7b9a2374e4be
                    Name: System Admin
                  ModifiedDate: '2026-07-27T11:07:34.9630042+00:00'
                  ExternalId: null
                  ETag: null
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
  /api/user-management/v1/users/{userId}/clone:
    post:
      tags:
      - User Admin
      summary: Clone a user
      description: 'Clones the user based on the user ID and returns the cloned user''s ID.<p>**Note**: User clone is not supported for the `Integration` user type.</p>'
      parameters:
      - name: userId
        in: path
        description: User ID
        required: true
        schema:
          type: string
      requestBody:
        description: Request model containing ExternalId and UserName fields for cloning a user.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCloneRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/UserCloneRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/UserCloneRequest'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: true
                Data: d4d0be32-e816-4520-a784-670c0b234d95
                StatusCode: Created
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
  /api/user-management/v1/users/{userId}/permissiongroups:
    delete:
      tags:
      - User Admin
      summary: Delete permission groups from a user
      description: Removes the permission group names from the provided user's current permission groups and returns the updatedUser object along with error messages for invalid records.
      parameters:
      - name: userId
        in: path
        description: User ID
        required: true
        schema:
          type: string
      requestBody:
        description: The list of permission groups to be deleted from a user.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeletePermissionGroups'
          text/json:
            schema:
              $ref: '#/components/schemas/DeletePermissionGroups'
          application/*+json:
            schema:
              $ref: '#/components/schemas/DeletePermissionGroups'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponseAPIResponse'
              example:
                Success: true
                Data:
                  FirstName: system
                  LastName: user
                  UserName: SystemUser
                  Email: systemuser@conga.com
                  Role:
                    Id: f45de8be-4f0a-443a-924e-e77a4eb9a64e
                    Name: SysAdmin
                  PermissionGroups: ScopePermissionGroup
                  RolePermissionGroups: null
                  Timezone: null
                  Locale: null
                  Currency: null
                  CurrencyFormat: null
                  IsDeleted: false
                  IsActive: true
                  IsSuspended: null
                  Alias: null
                  Language: null
                  SmallPhotoUrl: null
                  LastLoginDate: null
                  Address: 71 ST. NICHOLAS DRIVE
                  PhoneNumber: null
                  IdentityStatus: null
                  UserType: External
                  AdminPermissions: null
                  OrganizationExternalId: null
                  UserGroupsAssignedTo: null
                  Clientid: null
                  FederationId: null
                  IsNextGenUiEnabled: null
                  Id: null
                  Name: null
                  CreatedBy:
                    Id: a1949ee3-e003-437d-ab32-f466f2cbac3e
                    Name: System Admin
                  CreatedDate: '2026-07-27T11:07:35.038746+00:00'
                  ModifiedBy:
                    Id: 75cf2f9e-6c54-4e44-8f2a-f28038bcf3f2
                    Name: System Admin
                  ModifiedDate: '2026-07-27T11:07:35.0387534+00:00'
                  ExternalId: null
                  ETag: null
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
    put:
      tags:
      - User Admin
      summary: Assign permission group to a user
      description: Appends the permission group name to the provided user's current permission groups and returns the updatedUser object.
      parameters:
      - name: userId
        in: path
        description: User ID
        required: true
        schema:
          type: string
      requestBody:
        description: The list of permission groups to be assigned for a user.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssignPermissionGroups'
          text/json:
            schema:
              $ref: '#/components/schemas/AssignPermissionGroups'
          application/*+json:
            schema:
              $ref: '#/components/schemas/AssignPermissionGroups'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponseAPIResponse'
              example:
                Success: true
                Data:
                  FirstName: system
                  LastName: user
                  UserName: SystemUser
                  Email: systemuser@conga.com
                  Role:
                    Id: 9f3a76df-7972-4830-828a-eee1edb5f8e0
                    Name: SysAdmin
                  PermissionGroups: ScopePermissionGroup
                  RolePermissionGroups: null
                  Timezone: null
                  Locale: null
                  Currency: null
                  CurrencyFormat: null
                  IsDeleted: false
                  IsActive: true
                  IsSuspended: null
                  Alias: null
                  Language: null
                  SmallPhotoUrl: null
                  LastLoginDate: null
                  Address: 71 ST. NICHOLAS DRIVE
                  PhoneNumber: null
                  IdentityStatus: null
                  UserType: External
                  AdminPermissions: null
                  OrganizationExternalId: null
                  UserGroupsAssignedTo: null
                  Clientid: null
                  FederationId: null
                  IsNextGenUiEnabled: null
                  Id: null
                  Name: null
                  CreatedBy:
                    Id: 8c77b742-afc2-42e4-9e9b-5e973ffb2a6a
                    Name: System Admin
                  CreatedDate: '2026-07-27T11:07:35.0317101+00:00'
                  ModifiedBy:
                    Id: 327d457f-ce8d-4712-9a3f-5f35a059b2b9
                    Name: System Admin
                  ModifiedDate: '2026-07-27T11:07:35.031718+00:00'
                  ExternalId: null
                  ETag: null
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
  /api/user-management/v1/users/{userId}/restore:
    put:
      tags:
      - User Admin
      summary: Restore a deactivated user
      description: Based on the user ID, restores the user (if deactivated) and sends the message to auth.
      parameters:
      - name: userId
        in: path
        description: User ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: true
                Data: User Activate request has been processed. Kindly review identity status of user.
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
  /api/user-management/v1/users/{userId}/roles:
    get:
      tags:
      - User Admin
      summary: Get a user's role
      description: Retrieves a user's role based on the user ID and returns the status as the role name.
      parameters:
      - name: userId
        in: path
        description: User ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: true
                Data: SystemAdmin
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
  /api/user-management/v1/users/{userId}/roles/{roleId}:
    put:
      tags:
      - User Admin
      summary: Update a user's role
      description: Updates a user's role based on the user ID and role ID passed in.
      parameters:
      - name: userId
        in: path
        description: User ID to whom the role is to be assigned
        required: true
        schema:
          type: string
      - name: roleId
        in: path
        description: Role ID that is to be assigned to the specified user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponseAPIResponse'
              example:
                Success: true
                Data:
                  FirstName: system
                  LastName: user
                  UserName: SystemUser
                  Email: systemuser@conga.com
                  Role:
                    Id: b0a0b882-15e0-4879-b635-825355498c43
                    Name: ContractFacilitator
                  PermissionGroups: ScopePermissionGroup
                  Rol

# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-user-admin-api-openapi.yml