Synchronize data between IDM and DocuSign

This sample only works with DocuSign connector version 1.5.20.21 and lower. For more information, refer to the ICF documentation.

This sample demonstrates bidirectional synchronization between IDM managed users and DocuSign accounts.

The sample assumes that you have downloaded and installed the DocuSign connector and its dependencies, as described in Install the DocuSign connector. The sample also assumes that you have the DocuSign account information required to configure the connector, as described in Before you start.

Run the sample

In this section, you will do the following:

Start IDM with the sample configuration.
Configure the DocuSign connector and test your connection to DocuSign.
Reconcile your DocuSign service accounts with the IDM managed user repository.
Change a user in IDM and reconcile the changes back to DocuSign.

The mapping configuration file (sync.json) for this sample includes two mappings: systemDocusignAccount_managedUser and managedUser_systemDocusignAccount. You will use these mappings to reconcile users between IDM and DocuSign.

Start IDM with the configuration for the DocuSign sample:

cd /path/to/openidm/
./startup.sh -p samples/sync-with-docusign

To configure the DocuSign connector, do one of the following:
- Update samples/sync-with-docusign/conf/provisioner.openicf-docusign.json with your DocuSign account details.
- Use the admin UI to configure the connector.
Follow one of the procedures in Install the DocuSign connector to configure the connector.

Test the connection to DocuSign:

curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Accept-API-Version: resource=1.0" \
--request POST \
"http://localhost:8080/openidm/system?_action=test"
[
  {
    "name": "docusign",
    "enabled": true,
    "config": "config/provisioner.openicf/docusign",
    "connectorRef": {
      "bundleVersion": "1.5.0.0",
      "bundleName": "org.forgerock.openicf.connectors.docusign-connector",
      "connectorName": "org.forgerock.openicf.connectors.docusign.DocuSignConnector"
    },
    "displayName": "DocuSign Connector",
    "objectTypes": [
      "userSignature",
      "signingGroup",
      "__ALL__",
      "account",
      "contact"
    ],
    "ok": true
  }
]

A status of "ok": true indicates that the connector can connect to DocuSign.

If you configured the connector through the admin UI, the connection is tested as soon as you select Save.

To reconcile your existing DocuSign users with the IDM managed user repository, do one of the following:

Run the command:

curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Accept-API-Version: resource=1.0" \
--request POST \
"http://localhost:8080/openidm/recon?_action=recon&mapping=systemDocusignAccount_managedUser&waitForCompletion=true"
{
  "_id": "7dac3ea9-c6be-4ff9-ae46-d8a0431949b3-7745",
  "state": "SUCCESS"
}

In the admin UI, select Configure > Mappings, and then select Reconcile on the systemDocusignAccount_managedUser mapping.

In the admin UI, select Manage > User, and verify that your DocuSign users have been created as IDM managed users.
In the admin UI, select Manage > User, select a user to edit, and change some user properties.

To reconcile the users in the managed user repository with your DocuSign users, do one of the following:

Run the command:

curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Accept-API-Version: resource=1.0" \
--request POST \
"http://localhost:8080/openidm/recon?_action=recon&mapping=managedUser_systemDocusignAccount&waitForCompletion=true"
{
  "_id": "1f148024-45b9-4dc1-9c3f-29976e02db00-8700",
  "state": "SUCCESS"
}

In the admin UI, select Configure > Mappings, and then select Reconcile on the managedUser_systemDocusignAccount mapping.

In DocuSign, verify that the contact was updated.

For more information about the DocuSign connector, refer to DocuSign connector.

IDM 7.3.1

Synchronize data between IDM and DocuSign

Run the sample