# DocuSign eSignature Connector > SailPoint DocuSign eSignature Connector Documentation # Documentation # Account Aggregation Status The following table lists the mapped account statuses of DocuSign on SailPoint: | DocuSign Account Status | SailPoint Account Status | | --- | --- | | ActivationRequired | Enabled | | ActivationSent | Enabled | | Active | Enabled | | Disabled | Disabled | | Closed | Disabled | # Connecting SailPoint and DocuSign eSignature To connect SailPoint with DocuSign eSignature, perform the following tasks: ## Adding the Source in SailPoint To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs. > [!IMPORTANT] > > By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration. **To configure a new source:** 1. Sign in to SailPoint. 2. Go to **Admin \> Connections \> Sources**. 3. Select **Create New**. 4. Search for the connector by entering the name in the search box, and then select **Actions**. 5. In the **Actions** dropdown list, select the setup method: - [**Express Setup**](<#configuring-a-source-using-express-setup>) - Quickly create a read-only connection to your target system by providing minimal configurations and authentication. On completion, aggregation is automatically started. > **Note** > > Express Setup supports Credential Providers. For information on supported credential providers and configuration, refer to [Credential Providers](). For more information, contact your SailPoint Customer Service Manager. - [**Standard Setup**](<#configuring-a-source-using-standard-setup>) - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup. ### Configuring a Source Using Express Setup Express Setup minimizes the initial configuration process so you can quickly connect the application and immediately begin aggregating user account and entitlement data. 1. Review the directions and select **Start Express Setup**. 2. Review the pre-populated **Source Name**, **Source Owner**, and **Description**. To update, select **Edit**. > **Note** > > The source name must be unique. You can change these settings later in the source configuration. 3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a Credential Provider in SailPoint, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 4. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section. 5. Select **Finish**. After a successful test connection, the system creates your source and prompts you to run an aggregation. - If you want to aggregate now, select **Aggregate**. - To see the latest account aggregation history, go to **Account Management \> Account Aggregation**. - To see the list of aggregated source accounts, go to **Account Management \> Accounts**. - If you want to aggregate later, select **Exit**. This returns you to the **Sources** page. Your new source is listed, but contains no accounts or aggregation history yet. ### Configuring a Source Using Standard Setup Use Standard Setup to configure the connector for full feature support. 1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 2. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters. 3. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](). 4. (Optional) Select a governance group to grant its members [source]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 5. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](). 6. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there. ## Base Configuration Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary. 1. Enter a unique name and description for the source. 2. In the **Source Owner** dropdown list, select the identity that owns this source. - To find a source owner, begin entering their name. 3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a credential provider, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 4. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information. 5. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. For more information about governance groups, refer to [Associating Governance Groups with a Source](). 6. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default. - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system. - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source. 7. Select **Save**. ## Connection Settings You must provide the following information to connect and interact with the DocuSign eSignature application. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() The DocuSign eSignature source supports JSON Web Token (JWT) OAuth 2.0 flow. To connect with DocuSign, you must first create an integration application in DocuSign that provides an integration key and add an RSA key pair to the application. For more information about integration application creation, refer to the "Prerequisites" section of the [DocuSign documentation](). You must also get the user's consent for the application created in DocuSign to use the OAuth JWT Grant flow to impersonate that user and make API calls. For more information about requesting application consent, refer to the "Step 1. Request application consent" section of the [DocuSign documentation](). For JWT flow, the following scopes are required: **signature** and **impersonation**. 1. Select **Connection Settings** from the menu on the left of the screen. 2. Provide the following information to configure the DocuSign eSignature source: - **API URL**: Provide the DocuSign account base URL. - **Account ID**: Provide the DocuSign external account number (int) or account ID GUID. - **Client ID**: Provide the client identifier or integration key issued to the client during the registration process in the DocuSign application. - **User ID**: Provide the user of the user to be impersonated in the JWT flow. You must provide the User ID in GUID, and you must have the required consent in the DocuSign application. - **RSA Private Key**: Provide the RSA Private Key. You will use this key to generate a digital signature for a **JSON Web Token** (**JWT**). The key must include the `----BEGIN RSA PRIVATE KEY----` and `----END RSA PRIVATE KEY----` lines in the text. 3. Select **Save**. ## Activity Insights Settings SailPoint pulls in activity data in the form of events like user logins, password changes, and content updates within the application. You can view an identity’s activity data within an application to discover trends for that user. > [!IMPORTANT] > > Contact your SailPoint Customer Success Manager (CSM) for more information on Activity Insights. For more information on utilizing activity data, refer to [Activity Insights](). Activity Insights Settings allows you to gather account information and activity data from DocuSign eSignature. To enable Activity Insights for the DocuSign eSignature application, refer to [Prerequisites]() for more information. To configure Activity Insights, complete the following: > [!NOTE] > > **Screenshot** > > [![Activity Insights Settings]()]() 1. Go to **Activity Insights Settings**. 2. Select **Enable Activity Insights** to view access to data insights on source and application activity such as logins and other app-specific events. 3. Select **Save**. ## Aggregation Settings > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() 1. In **Account Filter**, specify the account filter conditions. To apply multiple filters, enter the filter and press the Enter key to add them to the list. > **Available Account Filters** > > | Attribute Name | Description | > | --- | --- | > | status | Filters results by user account status. A comma-separated list of any of the following: ActivationRequired, ActivationSent, Active, Closed, Disabled. For example, to aggregate accounts that are active, and will have an activation email sent to them; i.e. accounts with an `Active` and `ActivationSent` status, you can specify the filter as: status=Active,ActivationSent. Similarly, if you want to filter out accounts with user status as `Closed`; you can specify the filter as: status=Active,ActivationSent,ActivationRequired,Disabled. This will aggregate all the accounts except the accounts that are in the `Closed` state. | > | email | Filters results based on the email address associated with the user that you want to return. For example, to aggregate accounts that have a specific email, you can specify the filter as: `email=abc@example.com` | > | emailSubstring | Filters results based on a fragment of an email address. For example, when aggregating accounts that have a specific domain, you can specify the filter as: emailSubstring=example.com | > | userNameSubstring | Filters the user records returned by the user name or a sub-string of the user name. For example, to aggregate accounts with a sub-string, you can specify the filter as: userSubstring=ab | > | groupId | Filters results based on one or more group IDs. For example, to aggregate accounts that are part of a particular groupId, you can specify the filter as: groupId=12345 | > | notGroupId | Returns user records excluding the specified group IDs. For example, to aggregate accounts that are not part of a particular groupId, you can specify the filter as: notGroupId=12345 | > > > **Note** > > > > The email, emailSubstring, userNameSubstring, groupId, and notGroupId filters are only applicable to active users. To get these attributes for a user who is not active, the status filter needs to added along with them. For example, if you want to aggregate the emailSubstring of a user who has status as ActivationSent then you must provide two filters; `status=ActivationSent` and `emailSubstring=example.com` 2. In **Group Filter**, specify the group filter conditions, groupType = AdminGroup. To apply multiple filters, enter the filter and press the Enter key to add them to the list. > **Available Group Filters** > > | Attribute Name | Description | > | --- | --- | > | groupType | The type of group to return. Valid values: AdminGroup, CustomGroup, EveryoneGroup. For example, to aggregate groups with the group type as `AdminGroup`, you can specify the filter as: groupType=AdminGroup | > | searchText | Filters the results of a GET request based on the text that you specify. For example, to aggregate groups with a specific text, you can specify the filter as: searchText=Finance | 3. Select **Manage Permission Profiles as Entitlements** to include permission profiles in the entitlement aggregation. 4. Select **Save**. ## Review and Test Perform a test to confirm the connection to SailPoint. 1. Go to **Review and Test**. 2. Confirm that the entries in each field are correct. If you note any mistakes, return to the section and make corrections. 3. Select **Test Connection**. ## SailPoint Application Onboarding SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface. For more information, refer to [Application Onboarding]() in the SailPoint SaaS documentation. # Integrating SailPoint with DocuSign eSignature Use the DocuSign eSignature source to manage identity and access in the DocuSign application. The DocuSign eSignature source securely connects SailPoint with the DocuSign application to load data from the DocuSign application and provision changes to it. This document is designed to give specific information about the requirements and fields needed to successfully configure an instance of the DocuSign eSignature source. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The DocuSign eSignature connector supports the following features: - Access Certifications (certifications of entitlements connected to the accounts) - Add and Remove Entitlement - Aggregation of Accounts - Aggregation of Groups - Delete Accounts - Aggregation of Permission Profile as Entitlement > **Note** > > - To aggregate, enable the option to `Manage Permission Profiles as Entitlements` and run entitlement aggregation. > - To manage the permission profile as an entitlement for existing sources, add the permission profile as entitlement type using the API for [Update Source Schema | SailPoint Developer Community](). - Provisioning of Accounts - Create > **Note** > > For `Create Account`, the permission profile can be assigned to a user while creating an account and updating an account. - Update > **Note** > > DocuSign API does not let you update user's email address. Even if you see a successful HTTP response with a 200 code, the user's email address will not get changed. Refer to DocuSign APIs for more information. ### Activity Insights Activity Insights supports activity from DocuSign eSignature and its associated accounts. This allows you to gather account information and activity data from DocuSign eSignature. > [!IMPORTANT] > > Contact your SailPoint Customer Success Manager (CSM) for more information on Activity Insights. For more information on configuring Activity Insights, refer to Activity Insights Settings. ## Prerequisites The DocuSign eSignature source supports JSON Web Token (JWT) OAuth 2.0 flow. To connect with DocuSign, you must first create an integration application in DocuSign that provides an integration key and add an RSA key pair to the application. For more information about integration application creation, refer to the "Prerequisites" section of the [DocuSign documentation](). You must also get the user's consent for the application created in DocuSign to use the OAuth JWT Grant flow to impersonate that user and make API calls. For more information about requesting application consent, refer to the "Step 1. Request application consent" section of the [DocuSign documentation](). For JWT flow, the following scopes are required: **signature** and **impersonation**. # Machine Account Attributes ## Machine Account Provisioning Attributes The following table lists the attributes in the machine account creation template, including the generator and description for each attribute. | Attribute | Generator | Description | | --- | --- | --- | | userName | Static | Username of the account | | email | Static | Email of the account | | firstName | Static | First name of the account | | lastName | Static | Last name of the account | For more information, refer to [Machine Identity Security Overview](). # Schema Reference The application schema is used to configure the objects returned from a connector. > [!NOTE] > > - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas]() for more information. > - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified. The DocuSign eSignature connector uses the following default correlation and object configurations. ## Default Correlation Configuration Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements. You can customize the correlation configuration. Refer to [Assigning Source Accounts to Identities]() for more information. When you first create the DocuSign eSignature source, the default correlation mapping is: | Account Attribute | Operation | Identity Attribute | | --- | --- | --- | | email | Equals | Work Email (email) | | userName | Equals | SailPoint User Name (uid) | ## Default Account Schema Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location. The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas]() for more information. ### Default Account Attributes The DocuSign eSignature connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified. > [!NOTE] > > To manage `permissionProfile` as an entitlement, select `permissionProfileId` as an entitlement of type permissionProfile. | Attribute Name | Description | | --- | --- | | userId | The user's unique ID. | | userName | The user's name. | | userType | The user's type. | | isAdmin | True if the user holds admin permissions. | | isNAREnabled | True if National Association of Realtors (NAR) signature logos are enabled for the user. | | userStatus | The status of a user. | | uri | User's URI information. | | email | User's email ID. | | firstName | The first name of the user. | | lastName | The last name of the user. | | jobTitle | The job title of the user. | | company | The company name of the user. | | permissionProfileId | The user's membership to permission profile ID. | | permissionProfileName | The display name of a permission profile. | | sendActivationOnInvalidLogin | Indicates that an additional activation email is to be sent if the user's log on fails before the account is activated. | | enableConnectForUser | Indicates whether the user is enabled for updates from DocuSign Connect. | | defaultAccountId | User belongs to this account ID. | | createdDateTime | The creation date and time of the user. | | lastLogin | The last login information of the user. | | groups | The user's membership information. | ## Default Entitlement Attributes Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements]() for more information. > [!CAUTION] > > Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations. ### Entitlement Type: group | Attribute Name | Description | | --- | --- | | groupId | The group's unique ID | | groupName | The group's name | | groupType | The group's type | | permissionProfileId | A permission profile ID this group wraps | | usersCount | Count of members | ### Entitlement Type: permissionProfile | Attribute Name | Description | | --- | --- | | permissionProfileId | The permission unique ID | | permissionProfileName | The permission name | # Troubleshooting If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support. For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information: - [SailPoint Identity Services Documentation]() - [SailPoint Support Knowledge Base]() - [SailPoint Developer Community]() ## Debug Logs For information about managing additional source settings, including debug logging and downloading connector logs, refer to [Managing Additional Settings](). ## Provisioning for group and permission profiles is not working properly **Resolution**: When use cases are executed, the following behaviors determine whether provisioning is or is not supported on the connector end. **Group Entitlement** - Supported when the provisioning (add/remove) of a single test group is executed. - Removal of the Administrator and/or Everyone group is not supported. **Permission Profile** - Supported when the user has one permission profile. - Removal of the permission profile is not supported, however, it can be replaced with a new permission profile. ## 400 Bad Request error during test connection This happens when your consent is not provided in the DocuSign application to the client (SailPoint) application. **Resolution**: Ensure that you provide user consent with the required scope of "signature impersonation." For more information, refer to the "Step 1: Request application consent" section from the [DocuSign documentation]().