Integrate with Docusign at Account level

Integrating your Software Asset Management application with the Docusign service enables you to track your software subscriptions and to reclaim unused licenses.

Docusign purchases made through resellers don’t reflect within the Docusign standard billing system. So no values are returned through the APIs for envelope consumption that is available to ServiceNow.

重要:

Docusign has removed the lastLogin field from the Users API, so the user's last activities are no longer tracked as part of this integration. The Software Asset Management application now creates reclamation candidates based on the subscription assigned date.

For more information about the Docusign service, see the DocuSign Developer site.

重要:

Minimize security risks and protect information by granting access only to the necessary user or API permissions.

表 : 1. Minimal user permissions

Process	Required user role in the Docusign application	Authentication scopes
Download subscriptions	admin	No scopes
Reclaim subscription	admin	No scopes

Register a Docusign application

Register a Docusign application through the Docusign admin portal.

始める前に

Docusign Role required: admin

手順

1. Log in to your Docusign demo (non-production) account.
2. Select your profile picture.
3. Select My Apps and Keys.
   • If you already have an API integration key from a previous integration ready for use in production, skip to step 33.
   • If you don't have your client secret saved, you must generate a new one.
4. On the side pane, select INTEGRATIONS > Apps and Keys.
5. In the Apps and Integration Keys section, select ADD APP AND INTEGRATION KEY.
6. On the Add Integration Key form, provide a name in the App Name field and selectCREATE APP.
7. Select ADD URI under the Redirect URIs field in the Additional Settings section.
8. Add https://oauth.pstmn.io/v1/browser-callback.
9. Select ADD URI again and add https://ServiceNow instance.service-now.com/oauth_redirect.do.
10. Select ADD SECRET KEY.
    Save the Integration Key (Client ID) and Secret Key (Client secret) in a secure location to use them later in the Postman App and the Integration Key (Client ID) in the ServiceNow instance.
11. Select Save.
12. Download the latest version of Postman App and skip the login.
13. Select New Collection and provide a name to the collection.
14. Select the Authorization tab.
15. From the Type list menu, select OAuth 2.0.
16. Provide a name and complete the fields on the Configuration Options tab to create a token:

    Field	Value
    Callback URL	https://oauth.pstmn.io/v1/browser-callback
    Auth URL	https://account-d.docusign.com/oauth/auth
    Access Token URL	https://account-d.docusign.com/oauth/token
    Client ID	The integration key from your Docusign demo account created in step 10.
    Client Secret	The secret key from your Docusign demo account step 10.

17. Select Get New Access Token.
    You're redirected to Docusign.
18. Select Accept.
19. After the access token is collected and authentication is complete, copy the Access Token to use it later.
20. Select New Request to create a GET request for your account id.
21. Enter the URL in the GET field as https://account-d.docusign.com/oauth/userinfo.
22. On the Headers tab, select Authorization under KEY and enter Bearer <Access Token that you copied during authentication> under Value.
23. Select Send and verify that your request is complete.
    The account id is displayed in the response body.
24. Duplicate the GET request.
    Copy the authorization key and value under Headers.
25. Update the URL in the GET field to https://demo.docusign.net/restapi/v2/accounts/<account-id>/users.
    Here, account-id is the ID that you saved from the previous request.
26. Select Send 20 times to make 20 API calls.
    You must invoke a minimum of 20 API calls to register your application through the Docusign admin portal.
27. Navigate to Apps and Integration Keys on the Docusign admin portal.
28. Select Actions > View API Dashboard next to your application.
29. Wait a few minutes for Docusign to register all the 20 API calls.
30. Navigate to INTEGRATIONS > Apps and Keys and select Submit for review.
    After 5-20 minutes, your application review is complete. You can promote the application to your production account.
31. Select Actions > Start-Go- Live review to promote the application to the production account.
32. Select an eligible production account to manage the integration key.
33. Log in to your Docusign production account.
34. Select your profile picture.
35. Select Go to Admin.
36. On the side pane, select INTEGRATIONS > Apps and Keys.
    Locate your API Account ID to use for the integration profile in your ServiceNow instance.
37. Next to your application, select Actions > Edit.
38. Select ADD URI and add https://ServiceNow instance.service-now.com/oauth_redirect.do.
39. Select ADD SECRET KEY.
    Save the Secret Key (Client secret) for your production account in a secure location to use it in your ServiceNow instance.
40. Select Save.

Create a Docusign integration profile at Account level

Create a Docusign integration profile at Account level to track software subscriptions and optimize licensing for the Docusign service.

始める前に

To create a Docusign integration profile, request the Software Asset Management - SaaS License Management plugin (sn_sam_saas_int) from the ServiceNow Store.

ServiceNow Role required: sam_integrator

このタスクについて

If you’re using Software Asset Workspace, the option to create the Docusign integration profile in Core UI is inactive.

手順

1. Navigate to the integration profile.

   Interface	Action
   Core UI	Navigate to All > Software Asset > SaaS License > Direct Integration Profiles. Select New. Select DocuSign Integration Profile.
   Software Asset Workspace	Navigate to License operations > User Subscriptions > Direct integration profiles. Select New. Select DocuSign from the drop-down list. Select Continue.

2. On the form, fill in the fields.

   表 : 2. Integration Profile form

   Field	Description
   Display name	Name of the integration profile. For example, DocuSign Integration
   Integration type	The default value is set to Account Level.
   Client Id	Client ID for the OAuth application created in the SaaS admin account in the Register a Docusign application procedure.
   Redirect url	URL of the OAuth provider that you're redirected to after authentication. This value is automatically populated.
   Technical account Id	API Account ID from your Docusign production account.
   Instance URL	URL of the login page used for accessing your Docusign production account. This field is automatically set to https://account.docusign.com.
   Client secret	Password associated with the client ID created in the Register a Docusign application procedure.
   Profile type	Type of integration profile. This value is automatically set to DocuSign Subscription.

3. Review the required user roles or API permissions specified in the Vendor configuration field for each process to minimize security risks and optimize SaaS licenses.
   注:

   For more information about the required roles and scopes, see the Minimal user permissions table.

   • The Download subscriptions check box is selected by default and you can't clear it.

   • The Reclaim subscriptions check box is selected by default. If you don't want to reclaim subscriptions, you can clear this check box. If you clear it, the removal candidates are created but the reclaim subscription subflow isn't triggered or the reclamation process isn't initiated.

4. Select Submit.
   A draft integration profile is created.
5. On the integration profile, select Get OAuth Token and follow the steps to get an OAuth token.
   注:

   For the role required to perform this step, refer to the Minimal user permissions table.
6. On the integration profile form, select Validate Connection to verify the connection and credential details of this integration.

   Validating the connection verifies the Download Subscriptions APIs, but not the Reclaim Subscriptions APIs.

タスクの結果

You can view events performed by individual users up to one year prior to the current date. For more information, see Review a software reclamation rule. Software Asset Management pulls the events from the time that you start downloading user subscriptions irrespective of the profile creation date.

次のタスク

After the integration connects, your ServiceNow instance automatically creates software models, reclamation rules, and software subscriptions that are refreshed daily.

After creating an integration profile, view information about the profile in the Software Asset Workspace by navigating to License operations > User subscription > Direct integration profiles. You can select an integration profile to view the following related lists. If all of the following related lists aren't visible for an integration profile in the default view, you can select the custom integration view from the Details tab:

• Software Models
• Unrecognized Subscription Identifiers
• Scheduled Jobs
• Scheduled Job Results
• Software Subscriptions
• Subscription Identifier Exclusion Rule
• Subscription User Exclusion Rule

After creating an integration profile, you can define subscription exclusion rules to keep certain subscriptions from license cost calculations. For more information, see Subscription exclusions for SaaS and SSO applications.

If you want to set up multiple integration profiles with unique connections, create child aliases to manage different configurations and settings for each integration profile. For more information, see Create a child alias to set up multiple integration profiles.

Review all automatically generated reclamation rules to reclaim user subscriptions. For more information, see Review a software reclamation rule.

Create software entitlements for the automatically generated software models to track used software against owned software.

• For more information on creating software entitlements in the Software Asset Management Core UI, see Create entitlements in Software Asset Management classic.
• For more information on creating software entitlements in the Software Asset Workspace, see Create entitlements in workspace.
• For more information on creating software entitlements using the Software Asset Management Playbook, see Create entitlements using the guided walk-through.

Reconciliation also runs on your subscriptions as a scheduled job or on-demand. You can view your reconciliation results in the License Workbench (Software Asset Management classic application) or the License usage view (Software Asset Workspace). Use these results to determine your license compliance position and to remediate any non-compliance.

• For more information on running reconciliation in the Software Asset Management classic application, see Run software reconciliation in Software Asset Management classic.
• For more information on running reconciliation in the Software Asset Workspace, see Run software reconciliation in the workspace.