Conga

Conga Organization External Integration API

The Organization External Integration API from Conga — 4 operation(s) for organization external integration.

GitHub OpenAPI

Operations 10

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

DELETE /api/user-management/v1/integrations Delete external identifiers · Delete external identifiers #
Ask an LLM
“Can I remove all external identifiers from the org?”
“How do I delete integration identifiers in bulk?”
Tell an agent destructive · confirm first
Delete the external identifiers.
Remove org integration identifiers in bulk.
GET /api/user-management/v1/integrations List external integration identifiers · Get a list of external integration identifiers #
Ask an LLM
“Which external integrations are linked to our org?”
“Can I page through external integration identifiers?”
Tell an agent
List external integration identifiers.
Show {size} integration identifiers per page.
POST /api/user-management/v1/integrations Add an external identity integration · Add an external identifier #
Ask an LLM
“How do I connect a SAML identity provider?”
“Can I map an email domain to an external IdP?”
Tell an agent
Add external integration {ext} with provider {provider}.
Connect SAML metadata at {url} for domain {domain}.
PUT /api/user-management/v1/integrations Update external identifiers · Update external identifiers #
Ask an LLM
“How do I update several external identifiers at once?”
“Can I replace the integration identifiers for my org?”
Tell an agent
Update the external identifiers to {ids}.
Replace org integration identifiers with {ids}.
GET /api/user-management/v1/integrations/identity-providers List identity providers · Get all identity providers (IdPs) #
Ask an LLM
“Which identity providers can we sign in with?”
“What IdPs are configured?”
Tell an agent
List all identity providers.
Show configured IdPs.
DELETE /api/user-management/v1/integrations/{externalIntegrationId} Remove one integration's identifiers · Remove external identifiers #
Ask an LLM
“Can I remove the identifiers of a single integration?”
“How do I disconnect one external integration?”
Tell an agent destructive · confirm first
Remove identifiers of integration {id}.
Disconnect external integration {id}.
GET /api/user-management/v1/integrations/{externalIntegrationId} Get identifiers for an integration · Get external identifiers #
Ask an LLM
“Which identifiers belong to one external integration?”
“Can I page through one integration's identifiers?”
Tell an agent
Get identifiers for integration {id}.
Show identifiers of integration {id} sorted by {sort}.
POST /api/user-management/v1/integrations/{externalIntegrationId} Add identifiers to one integration · Add external identifiers #
Ask an LLM
“Can I add more identifiers to an existing integration?”
“How do I append identifiers to one external integration?”
Tell an agent
Add identifiers {ids} to integration {id}.
Append new identifiers to integration {id}.
PUT /api/user-management/v1/integrations/{externalIntegrationId} Update one integration's identifiers · Update external identifiers #
Ask an LLM
“How do I change the identifiers of one integration?”
“Can I replace identifiers on a single external integration?”
Tell an agent
Update identifiers of integration {id} to {ids}.
Replace identifiers on integration {id}.
PATCH /api/user-management/v1/integrations/{id} Edit an external identity integration · Update an external integration identifier #
Ask an LLM
“How do I change the SAML settings of one integration?”
“Can I make an integration the default IdP?”
Tell an agent
Edit integration {id} display name to {name}.
Set integration {id} default IdP to {default}.

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/authentication/conga-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/rate-limits/conga-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-organization-external-integration-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/data-model/conga-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/scopes/conga-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conventions/conga-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/errors/conga-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/lifecycle/conga-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conformance/conga-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/sandbox/conga-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/asyncapi/conga-webhooks.yml

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:conga-organization-external-integration-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 form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

conga-organization-external-integration-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: User Management Organization External Integration API
  version: v1
servers:
- url: https://rls.congacloud.com
security:
- Bearer: []
tags:
- name: Organization External Integration
paths:
  /api/user-management/v1/integrations:
    delete:
      tags:
      - Organization External Integration
      summary: Delete external identifiers
      description: Deletes external identifiers.
      requestBody:
        description: Unique record IDs of external system
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
          text/json:
            schema:
              type: array
              items:
                type: string
          application/*+json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: deleteApiUserManagementV1Integrations
      x-operation-id-source: derived
    get:
      tags:
      - Organization External Integration
      summary: Get a list of external integration identifiers
      description: Returns all external integration identifiers that meet the specified criteria, with support for sorting and pagination.
      parameters:
      - name: sortField
        in: query
        description: 'Field name for sorting. For example: Type.<p>**Note:** The sort field (in this case, Type) must 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:** If the sort field parameter is specified, the default sort order is DESC.</p>'
        schema:
          type: string
      - name: pageSize
        in: query
        description: 'The number of records to return. Default value: 10.'
        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
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: getApiUserManagementV1Integrations
      x-operation-id-source: derived
    post:
      tags:
      - Organization External Integration
      summary: Add an external identifier
      description: Add an organization's external integration identifier.
      parameters:
      - name: ExternalId
        in: query
        description: Unique record identifiers from the external system
        schema:
          type: string
      - name: Type
        in: query
        description: Type of the external system
        schema:
          type: string
      - name: Description
        in: query
        description: Description of the external integration identifier
        schema:
          type: string
      - name: Provider
        in: query
        description: Identity provider of external integration
        schema:
          type: string
      - name: DefaultIdp
        in: query
        description: Set the default identity provider
        schema:
          type: boolean
      - name: SAMLMetadataLocationURL
        in: query
        description: The SAML IDP's metadata information location(URL). For more information on how to get the URL, click [here.](https://documentation.conga.com/congaplatform/latest/getting-saml-identity-provider-settings-235406458.html)
        schema:
          type: string
      - name: SAMLExternalOrgIdClaimType
        in: query
        description: The SAML IDP's external org ID claim type. For more information on how to get this, click [here.](https://documentation.conga.com/congaplatform/latest/getting-saml-identity-provider-settings-235406458.html)
        schema:
          type: string
      - name: EmailDomain
        in: query
        description: Email domain of the external integration identifier
        schema:
          type: string
      - name: DisplayName
        in: query
        description: SAML provider Display Name
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                SAMLMetadataFile:
                  type: string
                  description: SAML Metadata File
                  format: binary
            encoding:
              SAMLMetadataFile:
                style: form
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: postApiUserManagementV1Integrations
      x-operation-id-source: derived
    put:
      tags:
      - Organization External Integration
      summary: Update external identifiers
      description: Updates an organization's external integration identifiers.
      requestBody:
        description: Details about external integration identifiers
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationExternalIntegrationUpdateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/OrganizationExternalIntegrationUpdateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/OrganizationExternalIntegrationUpdateRequest'
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: putApiUserManagementV1Integrations
      x-operation-id-source: derived
  /api/user-management/v1/integrations/identity-providers:
    get:
      tags:
      - Organization External Integration
      summary: Get all identity providers (IdPs)
      description: Retrieves all identity providers.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IDPMasterListAPIResponse'
              example:
                Success: true
                Data:
                - Name: Salesforce
                  ACRName: idp:Salesforce
                - Name: Salesforce Sandbox
                  ACRName: idp:SalesforceSandbox
                - Name: Microsoft
                  ACRName: idp:Microsoft
                StatusCode: OK
        '500':
          description: Internal Server Error
      operationId: getApiUserManagementV1IntegrationsIdentityProviders
      x-operation-id-source: derived
  /api/user-management/v1/integrations/{externalIntegrationId}:
    delete:
      tags:
      - Organization External Integration
      summary: Remove external identifiers
      description: Updates an organization's external integration and removes external identifiers.
      parameters:
      - name: externalIntegrationId
        in: path
        description: Organization ID is the external integration ID. It is onboarded as "OrganizationID" from the organization's demographics.
        required: true
        schema:
          type: string
      requestBody:
        description: Unique record IDs of external system
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
          text/json:
            schema:
              type: array
              items:
                type: string
          application/*+json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: deleteApiUserManagementV1IntegrationsByExternalIntegrationId
      x-operation-id-source: derived
    get:
      tags:
      - Organization External Integration
      summary: Get external identifiers
      description: Returns the external identifiers of an external integration.
      parameters:
      - name: externalIntegrationId
        in: path
        description: Organization ID is the external integration ID. It is onboarded as "OrganizationID" from the organization's demographics.
        required: true
        schema:
          type: string
      - name: sortField
        in: query
        description: 'Field name for sorting. For example: Type.<p>**Note:** The sort field (in this case, Type) must 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:** If the sort field parameter is specified, the default sort order is DESC.</p>'
        schema:
          type: string
      - name: pageSize
        in: query
        description: 'The number of records to return. Default value: 10.'
        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
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: getApiUserManagementV1IntegrationsByExternalIntegrationId
      x-operation-id-source: derived
    post:
      tags:
      - Organization External Integration
      summary: Add external identifiers
      description: Add an organization's external integration identifiers.
      parameters:
      - name: externalIntegrationId
        in: path
        description: Organization ID is the external integration ID. It is onboarded as "OrganizationID" from the organization's demographics.
        required: true
        schema:
          type: string
      requestBody:
        description: Details about external organization
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationExternalIntegrationCreateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/OrganizationExternalIntegrationCreateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/OrganizationExternalIntegrationCreateRequest'
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: postApiUserManagementV1IntegrationsByExternalIntegrationId
      x-operation-id-source: derived
    put:
      tags:
      - Organization External Integration
      summary: Update external identifiers
      description: Updates an organization's external integration identifiers.
      parameters:
      - name: externalIntegrationId
        in: path
        description: Organization ID is the external integration ID. It is onboarded as "OrganizationID" from the organization's demographics.
        required: true
        schema:
          type: string
      requestBody:
        description: Details about external integration identifiers
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationExternalIntegrationUpdateRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/OrganizationExternalIntegrationUpdateRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/OrganizationExternalIntegrationUpdateRequest'
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: putApiUserManagementV1IntegrationsByExternalIntegrationId
      x-operation-id-source: derived
  /api/user-management/v1/integrations/{id}:
    patch:
      tags:
      - Organization External Integration
      summary: Update an external integration identifier
      description: Updates an organization's external integration identifier.
      parameters:
      - name: id
        in: path
        description: External integration ID
        required: true
        schema:
          type: string
      - name: ExternalId
        in: query
        description: Unique record identifiers from the external system
        schema:
          type: string
      - name: Type
        in: query
        description: Type of the external system
        schema:
          type: string
      - name: Description
        in: query
        description: Description of the external integration identifier
        schema:
          type: string
      - name: Provider
        in: query
        description: Identity provider of external integration
        schema:
          type: string
      - name: DefaultIdp
        in: query
        description: Set the default identity provider
        schema:
          type: boolean
      - name: SAMLMetadataLocationURL
        in: query
        description: The SAML IDP's metadata information location(URL). For more information on how to get the URL, click [here.](https://documentation.conga.com/congaplatform/latest/getting-saml-identity-provider-settings-235406458.html)
        schema:
          type: string
      - name: SAMLExternalOrgIdClaimType
        in: query
        description: The SAML IDP's external org ID claim type. For more information on how to get this, click [here.](https://documentation.conga.com/congaplatform/latest/getting-saml-identity-provider-settings-235406458.html)
        schema:
          type: string
      - name: EmailDomain
        in: query
        description: Email domain of the external integration identifier
        schema:
          type: string
      - name: DisplayName
        in: query
        description: SAML provider Display Name
        schema:
          type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                SAMLMetadataFile:
                  type: string
                  description: SAML Metadata File
                  format: binary
            encoding:
              SAMLMetadataFile:
                style: form
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
      operationId: patchApiUserManagementV1IntegrationsById
      x-operation-id-source: derived
components:
  schemas:
    ExternalIntegrationIdentifierCreateRequest:
      type: object
      properties:
        ExternalId:
          type:
          - string
          - 'null'
          description: Unique record identifiers from the external system
        Type:
          type:
          - string
          - 'null'
          description: Type of the external system
        Description:
          type:
          - string
          - 'null'
          description: Description of the external integration identifier
        Provider:
          type:
          - string
          - 'null'
          description: Identity provider of external integration
        DefaultIdp:
          type: boolean
          description: Set the default identity provider
        SAMLMetadataLocationURL:
          type:
          - string
          - 'null'
          description: The SAML IDP's metadata information location(URL). For more information on how to get the URL, click [here.](https://documentation.conga.com/congaplatform/latest/getting-saml-identity-provider-settings-235406458.html)
        SAMLExternalOrgIdClaimType:
          type:
          - string
          - 'null'
          description: The SAML IDP's external org ID claim type. For more information on how to get this, click [here.](https://documentation.conga.com/congaplatform/latest/getting-saml-identity-provider-settings-235406458.html)
        EmailDomain:
          type:
          - string
          - 'null'
          description: Email domain of the external integration identifier
        SAMLMetadataFile:
          type:
          - string
          - 'null'
          description: SAML Metadata File
          format: binary
        DisplayName:
          type:
          - string
          - 'null'
          description: SAML provider Display Name
      additionalProperties: false
    HttpStatusCode:
      enum:
      - Continue
      - SwitchingProtocols
      - Processing
      - EarlyHints
      - OK
      - Created
      - Accepted
      - NonAuthoritativeInformation
      - NoContent
      - ResetContent
      - PartialContent
      - MultiStatus
      - AlreadyReported
      - IMUsed
      - MultipleChoices
      - MovedPermanently
      - Found
      - SeeOther
      - NotModified
      - UseProxy
      - Unused
      - TemporaryRedirect
      - PermanentRedirect
      - BadRequest
      - Unauthorized
      - PaymentRequired
      - Forbidden
      - NotFound
      - MethodNotAllowed
      - NotAcceptable
      - ProxyAuthenticationRequired
      - RequestTimeout
      - Conflict
      - Gone
      - LengthRequired
      - PreconditionFailed
      - RequestEntityTooLarge
      - RequestUriTooLong
      - UnsupportedMediaType
      - RequestedRangeNotSatisfiable
      - ExpectationFailed
      - MisdirectedRequest
      - UnprocessableEntity
      - Locked
      - FailedDependency
      - UpgradeRequired
      - PreconditionRequired
      - TooManyRequests
      - RequestHeaderFieldsTooLarge
      - UnavailableForLegalReasons
      - InternalServerError
      - NotImplemented
      - BadGateway
      - ServiceUnavailable
      - GatewayTimeout
      - HttpVersionNotSupported
      - VariantAlsoNegotiates
      - InsufficientStorage
      - LoopDetected
      - NotExtended
      - NetworkAuthenticationRequired
      type: string
    IDPMaster:
      type: object
      properties:
        Name:
          type:
          - string
          - 'null'
        ACRName:
          type:
          - string
          - 'null'
      additionalProperties: false
    OrganizationExternalIntegrationUpdateRequest:
      type: object
      properties:
        ExternalIntegrationIdentifiers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ExternalIntegrationIdentifierUpdateRequest'
      additionalProperties: false
    OrganizationExternalIntegrationCreateRequest:
      type: object
      properties:
        ExternalIntegrationIdentifiers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ExternalIntegrationIdentifierCreateRequest'
          description: Unique record ID of the external system
      additionalProperties: false
    IDPMasterListAPIResponse:
      type: object
      properties:
        Success:
          type: boolean
        RecordCount:
          type:
          - integer
          - 'null'
          format: int64
        Data:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/IDPMaster'
        Errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
        Profile:
          type:
          - string
          - 'null'
        TotalTime:
          type: number
          format: float
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        HasMoreRecords:
          type:
          - boolean
          - 'null'
        NextCursor:
          type:
          - string
          - 'null'
        Warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ErrorDetail'
      additionalProperties: false
    ExternalIntegrationIdentifierUpdateRequest:
      type: object
      properties:
        ExternalId:
          type:
          - string
          - 'null'
          description: Unique record identifiers from the external system
        Type:
          type:
          - string
          - 'null'
          description: Type of the external system
        Description:
          type:
          - string
          - 'null'
          description: Description of the external integration identifier
        DefaultIdp:
          type:
          - boolean
          - 'null'
          description: Enable default identity provider
          default: false
        EmailDomain:
          type:
          - string
          - 'null'
          description: Email domain of the external integration identifier
      additionalProperties: false
    ErrorDetail:
      type: object
      properties:
        Message:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header