How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Conga Role API

The Role API from Conga — 6 operation(s) for role.

Conga Role API is one of 347 APIs that Conga publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Role. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 11 operations across 6 paths, and defines 55 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://rls.congacloud.com/api/sign, https://rls.congacloud.com.

11 operations 6 paths 55 schemas 2 DELETE3 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://rls.congacloud.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Conga Role API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (JWT). An API key is passed in the header as Authorization (Bearer).

  • JWT — Provide oauth authentication
  • Bearer — Please insert JWT with Bearer into field

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 2 DELETE, 3 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Role 11
POST
/v1/cs-packages/{packageId}/groups
Adds a new ad hoc group to a transaction
Role_CreateAdHocGroup 1 param body → 200400401403404500
DELETE
/v1/cs-packages/{packageId}/groups/{roleId}
Deletes a specified ad hoc group
Role_DeleteAdHocGroup 2 params → 200400401403404500
PUT
/v1/cs-packages/{packageId}/groups/{roleId}
Updates a transaction's existing ad hoc group
Role_UpdateAdHocGroup 2 params body → 200400401403404500
POST
/v1/cs-packages/{packageId}/roles
Add new role
Role_CreateRole 1 param body → 200400401404500
GET
/v1/cs-packages/{packageId}/roles
Retrieve all package roles
Role_ListRoles 1 param → 200400401404500
PUT
/v1/cs-packages/{packageId}/roles
Reorder package roles
Role_ReorderRoles 1 param body → 200400401404500
DELETE
/v1/cs-packages/{packageId}/roles/{roleId}
Delete a role
Role_DeleteRole 2 params → 204400401404500
GET
/v1/cs-packages/{packageId}/roles/{roleId}
Retrieve a role
Role_GetRole 2 params → 200400401404500
PUT
/v1/cs-packages/{packageId}/roles/{roleId}
Update roles in the package
Role_UpdateRole 2 params body → 200400401404500
POST
/v1/cs-packages/{packageId}/roles/{roleId}/unlock
Unlock a role
Role_UnlockRole 2 params body → 200400401404500
GET
/api/user-management/v1/runtime/roles
Get all roles
5 params → 200400

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are Signer (26 properties), Plan (12 properties), Role (12 properties), SignerInformationForEquifaxCanada (11 properties). Each schema is shown below with its type and property counts.

Translation
object
Field localization.
5 properties
Address
object
6 properties
AttachmentRequirement
object
Attachment requirements and settings.
8 properties
RoleReordering
object
2 properties
Quota
object
4 properties
NotificationMethods
object
Represents the default notification methods for a signer in a transaction.
2 properties
AttachmentFile
object
Attachment file information.
4 properties
UserCustomField
object
Object to manage a user custom field
5 properties
Company
object
Company information.
4 properties
IdvWorkflow
object
4 properties
AuthChallenge
object
3 properties
SignerInformationForLexisNexis
object
Signer identity details needed for LexisNexis verification.
10 properties
Error2
object
Object representing an error condition
6 properties
GroupMember
object
Object to manage a group member
6 properties
TextualSignatureStyle
object
Object to manage a text signature
2 properties
License
object
License information.
5 properties
Auth
object
Signer auth settings.
4 properties
AuthScheme
string
Transaction
object
3 properties
External
object
External integration provider settings.
4 properties
KnowledgeBasedAuthenticationStatus
string
Signer
object
Object to manage a signer
26 properties
RoleType
string
CcExpiration
object
2 properties
CreditCard
object
5 properties
Account
object
Account information.
11 properties
NotificationMethod
string
Enumerates all available notification methods.
KnowledgeBasedAuthentication
object
Object to manage KBA
7 properties
Price
object
Object to manage price
2 properties
AuthWithQaSms
object
Represents a question/answer or SMS-based verification challenge.
4 properties
SignerType
string
Type of signer in OneSpan Sign
Plan
object
12 properties
Entity
object
Object used to manage entities from Microsoft Dynamics
3 properties
MemberType
string
Type of member in a group
ProfessionalIdentityField
object
Object to manage professional identity field
7 properties
CycleCount
object
2 properties
LicenseStatus
string
SignerInformationForEquifaxUSA
object
Object to manage Equifax USA information
11 properties
SignatureStyle
object
2 properties
Delivery
object
Object to manage delivery of completed documents
3 properties
RequirementStatus
string
Cycle
string
AccountProviders
object
2 properties
Provider
object
Object to manage account providers for documents and users
4 properties
Target
string
Group
object
Object to manage a group
10 properties
BaseMessage
object
1 property
Role
object
12 properties
CustomField
object
A custom field is one that, at the time of signing, is automatically populated with data that is specific to the signer. For instance, a signer might have an A…
6 properties
Currency
object
The currency used for the Price object
3 properties
ResultOfRole
object
Object used to manage OneSpan list types
2 properties
SignerInformationForEquifaxCanada
object
Object to manage Equifax Canada information
11 properties
StringObjectDictionaryListAPIResponse
object
10 properties
ErrorDetail
object
1 property
HttpStatusCode
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

conga-role-api-openapi.yml Raw ↑

Other APIs Conga publishes across the network.

Conga Advantage Platform MCP Server
Conga GraphQL API
Conga 2. Order Actions API
Conga 3. Order Line Items API
Conga Account API
Conga Account Attachments Blacklist API
Conga Account Attachments Whitelist API
Conga Account Designer Settings API
Conga Account Email Reminder Settings API
Conga Account Feature Settings API
Conga Account Package Settings API
Conga Account Roles API
Where this information came from

This is an independent, third-party profile of Conga Role API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.