Skip to content

Commit 0eae750

Browse files
narendranandaniya-crestakaila-crest
narendranandaniya-crest
and
akaila-crest
authored
DDSaaS: Docusign: README changes (#19047)
* updated readme as per review * update readme as per new format --------- Co-authored-by: akaila-crest <abhi.kaila@crestdata.ai>
1 parent 1e554cc commit 0eae750

File tree

1 file changed

+48
-80
lines changed

1 file changed

+48
-80
lines changed

‎docusign/README.md

Lines changed: 48 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -8,78 +8,49 @@ Docusign integration provides real-time insights into Docusign activities, such
88

99
## Setup
1010

11-
### Configuration
12-
13-
#### Prerequisites
14-
15-
- Docusign Developer Account, Account Type, Docusign Account Name, UserID, Integration Key, RSA Private Key (Refer to the [steps](#set-up-your-account) below)
16-
- A Docusign account with a plan that includes Docusign Monitor
17-
18-
#### Set up your account
19-
20-
For first-time setup:
21-
22-
1. Go to the [Developer Center][2] and select **Developer Account**.
23-
1. Choose **Create Account**. For first-time setup, the Account Type will be `Developer`.
24-
1. Navigate to the [Developer Admin Console][3].
25-
1. Under the **Account** section, click **Account Profile** .
26-
1. From the **Account Name** section, copy the Docusign account name.
27-
1. Under the **Integrations** section, select **Apps and Keys**.
28-
1. From the **My Account Information** section, copy the **User ID**.
29-
1. Click **Add App and Integration Key**.
30-
1. Provide an app name and create the app.
31-
1. Copy the generated **Integration Key**, under the General Info section.
32-
1. Scroll to the Service Integration section, and click on **Generate RSA**.
33-
1. Copy only the **RSA Private Key** to a safe location (it won't be displayed again).
34-
1. In the **Additional settings** section, under **Redirect URIs**, click "Add URI."
35-
1. Add the URI `http://localhost/`, and click **Save**.
36-
37-
For production account setup:
38-
39-
1. Ensure you have completed the [go-live][4] steps.
40-
1. For the production account setup, the Account Type will be `Production`.
41-
1. Navigate to the [Admin Console][5].
42-
1. Under the **Account** section, click **Account Profile**.
43-
1. From the **Account Name** section, copy the Docusign account name.
44-
1. Under the **Integrations** section, select **Apps and Keys**.
45-
1. Select the app that has been duplicated from your developer account.
46-
1. Under the **General Info** section, find and copy the generated **Integration Key**.
47-
1. Scroll to the **Service Integration** section, and click **Generate RSA**.
48-
1. Copy only the **RSA Private Key** to a safe location (it won't be displayed again).
49-
1. In the **Additional settings** section, under **Redirect URIs**, click "Add URI."
50-
1. Add the URI `http://localhost/`, and click **Save**.
51-
52-
#### Obtain JWT consent
53-
54-
1. Construct your consent URI::
55-
- **Syntax:**`<BASE_URI>/oauth/auth?response_type=code&scope=signature impersonation organization_read&client_id=<YOUR_INTEGRATION_KEY>&redirect_uri=<YOUR_REDIRECT_URI>`
56-
- Replace `<BASE_URI>`with:
57-
1. `https://account-d.docusign.com` for a developer account.
58-
2. `https://account.docusign.com` for production account.
59-
- Replace `<YOUR_INTEGRATION_KEY>` with your Integration Key (Client ID).
60-
- Replace `<YOUR_REDIRECT_URI>` with your redirect URI, such as `http://localhost/`.
61-
2. Open the constructed URI in an embedded browser.
62-
3. The user will be prompted to log in to their Docusign account (if not already logged in) and grant consent for your application to impersonate them with the specified scopes.
63-
4. After consent is granted, Docusign will redirect the user's browser to your specified redirect URI with extra information in the URL, indicating successful consent without needing to use the extra parameters directly.
64-
65-
66-
**Note:**
67-
- For a localhost URI, the redirect will occur on the same page.
68-
- The impersonated user must be a Docusign administrator or have the Security Reports Administrator permissions profile. For information about permission profiles, see [Docusign Administrator Permission Profiles][6] in the Organization Administrators topic.
69-
- To ingest data from a [production account][7], complete the [Docusign go-live process][4]. After the go-live process, follow the [account setup steps](#set-up-your-account) to generate configuration information for your production account.
70-
71-
### Configure the Docusign Datadog integration
72-
73-
1. Navigate to `Docusign`.
74-
2. Add your Docusign credentials.
75-
76-
| Docusign Parameters | Description |
77-
| --------------------- |------------ |
78-
| Account Type | Dropdown to select between different types of Docusign accounts (for example, developer or production) |
79-
| Docusign Account Name | The name associated with the Docusign account (case sensitive) |
80-
| User Id | A GUID value that uniquely identifies a Docusign user |
81-
| Integration Key | A unique GUID that identifies a Docusign integration |
82-
| RSA Private Key | A cryptographic key for signing JWT tokens for secure API authentication |
11+
12+
### Prerequisites
13+
14+
- Docusign Developer Account
15+
- Docusign account with a plan that includes Docusign Monitor
16+
17+
18+
### Generate API credentials in Docusign
19+
20+
1. Log in to [Developer Admin Console][2].
21+
2. Get your **Account Name** from the **Account Profile** page.
22+
3. Access the **Apps and Keys** page under the **Integrations** section.
23+
4. Obtain the **User ID** from the **My Account Information** section.
24+
5. Click on **Add App and Integration Key** button.
25+
6. Provide an App Name and click **Create App**.
26+
7. Get your **Integration Key** from the General Info section.
27+
8. Click on **Generate RSA**, to get **RSA Private Key**.
28+
9. Click on **ADD URI**, set Redirect URI to `http://localhost/`.
29+
10. Click on **Save** button.
30+
11. Perform application consent by opening the accompanying Sample URL after replacing the placeholders
31+
- URL: `<BASE_URI>/oauth/auth?response_type=code&scope=signature impersonation organization_read&client_id=<YOUR_INTEGRATION_KEY>&redirect_uri=<YOUR_REDIRECT_URI>`
32+
- `<BASE_URI>`: Use `https://account-d.docusign.com` for Developer or `https://account.docusign.com` for Production.
33+
- `<YOUR_INTEGRATION_KEY>`: Replace with your Integration Key (Client ID) obtained previously.
34+
- `<YOUR_REDIRECT_URI>`: Replace with your redirect URI, e.g., `http://localhost/`.
35+
- Sign in to your account if prompted to
36+
- Click on **Allow Access**
37+
- Note: _After selecting Accept, the browser will display a message saying that it can't load the page. You can safely ignore this page and close the tab._
38+
12. To test the integration with Developer account, select `Developer` option for the **Account Type** configuration parameter of the integration.
39+
13. Perform the [Go-Live][3] process for the App to access the [Production Account][4].
40+
14. Navigate to the Admin console and perform steps 2 to 10 and update the respective configuration parameters for the integration.
41+
42+
43+
### Connect your Docusign Account to Datadog
44+
45+
1. Add your Account Type, Docusign Account Name, User Id, Integration Key, and RSA Private Key
46+
|Parameters|Description|
47+
|--------------------|--------------------|
48+
|Account Type|Dropdown to select the type of Docusign account (e.g., Developer or Production).|
49+
|Docusign Account Name|The name associated with the Docusign account (case sensitive).|
50+
|User ID |A GUID value that uniquely identifies a Docusign user.|
51+
|Integration Key|A unique GUID that identifies a Docusign integration.|
52+
|RSA Private Key|A cryptographic key for signing JWT tokens for secure API authentication.|
53+
2. Click the Save button to save your settings.
8354

8455
## Data Collected
8556

@@ -97,13 +68,10 @@ The Docusign integration does not include any events.
9768

9869
## Support
9970

100-
For further assistance, contact [Datadog Support][8].
71+
For further assistance, contact [Datadog Support][5].
10172

10273
[1]: https://www.docusign.com/
103-
[2]: https://developers.docusign.com/
104-
[3]: https://apps-d.docusign.com/admin/admin-dashboard
105-
[4]: https://developers.docusign.com/platform/go-live/
106-
[5]: https://apps.docusign.com/admin/admin-dashboard
107-
[6]: https://support.docusign.com/s/document-item?bundleId=rrf1583359212854&topicId=god1583359152535.html
108-
[7]: https://account.docusign.com/
109-
[8]: https://docs.datadoghq.com/help/
74+
[2]: https://apps-d.docusign.com/admin/admin-dashboard
75+
[3]: https://developers.docusign.com/platform/go-live/
76+
[4]: https://apps.docusign.com/admin/admin-dashboard
77+
[5]: https://docs.datadoghq.com/help/

0 commit comments

Comments
 (0)