Conga

Conga Document Protection API

This class contains API endpoints for Document protection.

GitHub OpenAPI

Operations 4

POST /api/xauthor/v1/documents/protect Add document protection
POST /api/xauthor/v1/documents/unprotect Remove document protection
GET /api/xauthor/v1/documents/{currentprotection}/protections Get the protection type of document.
GET /api/xauthor/v1/documents/{saveoption}/protection Get the protection level of document.

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-documentprotection-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-documentprotection-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

conga-documentprotection-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: X-Author Document Protection API
  version: v1
  description: This class contains API endpoints for Document protection.
servers:
- url: https://xauthor-prod-rls10.congacloud.com
- url: https://xauthor-preview-rls09.congacloud.com
security:
- bearerAuth: []
tags:
- name: DocumentProtection
  description: This class contains API endpoints for Document protection.
paths:
  /api/xauthor/v1/documents/protect:
    post:
      tags:
      - DocumentProtection
      summary: Add document protection
      description: The protect an agreement document feature lets you to protect the agreement document without entering the password. This way, you can prevent sharing of passwords and unauthorized access to the document. This API enables protection of the document based on the parameters passed in the request body. Fields passed in the request body include Agreement Name, and Protection Level.
      parameters:
      - name: OrgType
        in: header
        required: true
        schema:
          type: string
          default: RLP
      requestBody:
        description: Request which contains document content
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectUnProtectRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectUnProtectRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectUnProtectRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectUnProtectRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          description: Server Error
  /api/xauthor/v1/documents/unprotect:
    post:
      tags:
      - DocumentProtection
      summary: Remove document protection
      description: The unprotect an agreement document feature lets you to unprotect an agreement document without entering the password. This way, you can prevent sharing of passwords and unauthorized access to the document. This API disables protection of the document and applies full access to it based on the parameters passed in the request body. Fields passed in the request body include Agreement Name, and Protection Level.
      parameters:
      - name: OrgType
        in: header
        required: true
        schema:
          type: string
          default: RLP
      requestBody:
        description: Request which contains document content
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectUnProtectRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectUnProtectRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectUnProtectRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectUnProtectRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          description: Server Error
  /api/xauthor/v1/documents/{currentprotection}/protections:
    get:
      tags:
      - DocumentProtection
      summary: Get the protection type of document.
      parameters:
      - name: currentprotection
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectionType'
      - name: OrgType
        in: header
        required: true
        schema:
          type: string
          default: RLP
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectionType'
            application/json:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectionType'
            text/json:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectionType'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          description: Server Error
  /api/xauthor/v1/documents/{saveoption}/protection:
    get:
      tags:
      - DocumentProtection
      summary: Get the protection level of document.
      parameters:
      - name: saveoption
        in: path
        description: Type of the version as save option
        required: true
        schema:
          $ref: '#/components/schemas/Conga.XAuthor.Common.Enum.VersionTypeEnum'
      - name: OrgType
        in: header
        required: true
        schema:
          type: string
          default: RLP
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectionType'
            application/json:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectionType'
            text/json:
              schema:
                $ref: '#/components/schemas/Apttus.XAuthor.Core.Model.ProtectionType'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          description: Server Error
components:
  schemas:
    Conga.XAuthor.Common.Enum.VersionTypeEnum:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      type: integer
      format: int32
    Apttus.XAuthor.Core.Model.ProtectUnProtectRequest:
      type: object
      properties:
        documentContent:
          type:
          - string
          - 'null'
      additionalProperties: false
    Apttus.XAuthor.Core.Model.ProtectionType:
      enum:
      - 0
      - 1
      - 2
      - 3
      - -1
      type: integer
      format: int32
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT