Creating an Integration User for Sign API
Conga Sign for Advantage Platform developers will need to set up an Integration User in order to acquire the Client ID and Secret, so that you may utilize Conga Sign API solutions.
You can also go through a manual creation processes in Conga Advantage Platform to create Integration users by following the Adding Users documentation.
Create the Integration User
The endpoint below creates an Integration user and returns the ID of this new user.
POST <host domain>/api/user-management/v1/usersThe following fields are required:
FirstName
LastName
UserType
Role
Email
{
"FirstName": "integrationuser144",
"LastName": "test01",
"Email": "daprajapati@conga.com",
"UserType": "Integration",
"Role": {
"Name": "CongaSign Integration Role"
}
}{
"Success": true,
"Data": "717e5ad5-152b-265c-1ea6-76300cf2aca0",
"StatusCode": "Created"
}Get the Integration User's ClientId
The endpoint below uses the Integration user ID and returns the associated ClientId. If a ClientId is already associated with the Integration user, the ClientId will return as a null value.
GET /api/user-management/v1/users/{integrationUserId}/secret| Field | Type | Description | Required |
|---|---|---|---|
integrationUserId | string | Integration user ID | Yes |
{
"Success": true,
"Data": {
"ClientId": "ba93226b-d73f-4bfb-92c5-4fe3618eca9e"
},
"StatusCode": "OK"
}Generate Integration User Secret
This endpoint generates the User Secret based on the Integration Users ClientId.
Patch /api/user-management/v1/users/{integrationUserId}/secret| Field | Type | Description | Required |
|---|---|---|---|
integrationUserId | string | Integration user ID | Yes |
{
"Success": true,
"Data": {
"ClientId": "ba93226b-d73f-4bfb-92c5-4fe3618eca9e",
"ClientSecret": "****************"
},
"StatusCode": "OK"
}