Skip to content

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 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

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.