DocuSign Capabilities

Last updated: October 7, 2024

After this article...

You'll understand the capabilities our DocuSign integration provides, and how Lumos interacts with the DocuSign API.

View users

The mapping between DocuSign user statuses and Lumos user account statuses is below.

DocuSign User Status

Lumos Account Status

The user has at least one "active" account membership across your organizations

Active

The user has no "active" accounts, but at least one "activation_sent" account

Access Created

The user has no "active" or "activation_sent" accounts, but at least one "activation_required" account.

Staged

The user only has "closed" or "disabled" account memberships.

Deprovisioned

DocuSign API endpoint: https://developers.docusign.com/docs/admin-api/reference/usermanagement/users/getusers/ (we use the "status" for the user's memberships)

View a user's entitlements

Lumos can retrieve the following user entitlements from DocuSign.

  • Role - The user's roles in your DocuSign organization (DocuSign Sender, DocuSign Viewer, etc.)

DocuSign API endpoint: https://developers.docusign.com/docs/admin-api/reference/usermanagement/esignusermanagement/getuserprofiles/ (we retrieve the "permission_profile")

Deprovision a user

AppStore

Offboarding

Access Reviews

License Management

N/A

In Lumos, deprovisioning a DocuSign user marks their Account Status as "Deprovisioned".

In DocuSign, this action removes the user's memberships to all of the accounts they belong to in your DocuSign organization.

Users with the Role "Organization Admin" cannot be deprovisioned via the DocuSign API. Any attempt to deprovision these users in Lumos will fail.

This action reclaims a license in DocuSign.

DocuSign API endpoint: https://developers.docusign.com/docs/admin-api/reference/users/users/closememberships/

DocuSign API documentation