Users: get

Retrieves the user information for the specified user.

To return additional user information that details the last login date, login status, and the user's password expiration date, set the optional additional_info query string parameter to true.

Request

HTTP request

GET /v2.1/accounts/{accountId}/users/{userId}

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Administrator on the account, this can be another user the Admin user is accessing. Note: For Envelopes:listStatusChanges (GET /v2.1/accounts/{accountId}/envelopes), the user_id query parameter is not implemented and should not be used.

Optional Query Parameters
additional_infostring

Setting this parameter has no effect in this operation.

emailstring

Setting this parameter has no effect in this operation.

Responses

CodeDescriptionReference
200

Successful response.

Users
400

Error encountered.

errorDetails

SDK Method

Users::getInformation

Definitions

addressInformation

Contains address information.

address1string

The first line of the user's address. Maximum length: 100 characters.

address2string

The second line of the user's address. Maximum length: 100 characters.

citystring

The user's city.

countrystring

The user's country.

faxstring

A fax number associated with the address, if one is available.

phonestring

A phone number associated with the address.

postalCodestring

The user's postal code.

stateOrProvincestring

The user's state or province.

connectUserObject

configurationtypestring

The type of custom Connect configuration being accessed.

connectIdstring

The ID of the custom Connect configuration being accessed.

enabledstring

Boolean value that indicates whether the custom Connect configuration is enabled or not.

hasAccessstring

senderSearchableItems[array]

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

forgottenPasswordInformation

A complex element that has up to four Question/Answer pairs for forgotten password information.

forgottenPasswordAnswer1string

The answer to the first forgotten password challenge question.

forgottenPasswordAnswer2string

The answer to the second forgotten password challenge question.

forgottenPasswordAnswer3string

The answer to the third forgotten password challenge question.

forgottenPasswordAnswer4string

The answer to the fourth forgotten password challenge question.

forgottenPasswordQuestion1string

The first challenge question presented to a user who has forgotten their password.

forgottenPasswordQuestion2string

The second challenge question presented to a user who has forgotten their password.

forgottenPasswordQuestion3string

The third challenge question presented to a user who has forgotten their password.

forgottenPasswordQuestion4string

The fourth challenge question presented to a user who has forgotten their password.

group

Information about groups.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

groupIdstring

The DocuSign group ID for the group.

groupNamestring

The name of the group.

groupTypestring

The group type. Potential values for POST and PUT requests include:

  • adminstrators
  • everyone
  • customGroup

permissionProfileIdstring

The ID of the permission profile associated with the group. Potential values include:

  • 2301416 (for the DocuSign Viewer profile)
  • 2301415 (for the DocuSign Sender profile)
  • 2301414 (for the Account Administrator profile)

users[userInfo]

A list of the users in the group.

usersCountstring

The total number of users in the group.

localePolicy

addressFormatstring

addressFormatMetadatasettingsMetadata

allowRegionstring

calendarTypestring

calendarTypeMetadatasettingsMetadata

cultureNamestring

cultureNameMetadatasettingsMetadata

currencyCodestring

The currency code for the account, based on the ISO 4217 currency code.

currencyCodeMetadatasettingsMetadata

currencyNegativeFormatstring

currencyNegativeFormatMetadatasettingsMetadata

currencyPositiveFormatstring

currencyPositiveFormatMetadatasettingsMetadata

customDateFormatstring

customSignDateFormatstring

customSignTimeFormatstring

customTimeFormatstring

dateFormatstring

dateFormatMetadatasettingsMetadata

effectiveAddressFormatstring

effectiveCalendarTypestring

effectiveCurrencyCodestring

effectiveCurrencyNegativeFormatstring

effectiveCurrencyPositiveFormatstring

effectiveCustomDateFormatstring

effectiveCustomTimeFormatstring

effectiveDateFormatstring

effectiveInitialFormatstring

effectiveNameFormatstring

effectiveTimeFormatstring

effectiveTimeZonestring

initialFormatstring

initialFormatMetadatasettingsMetadata

nameFormatstring

nameFormatMetadatasettingsMetadata

signDateFormatstring

The format for the signature date. Valid values are:

  • d/M/yyyy
  • dd-MM-yy
  • dd-MMM-yy
  • dd-MM-yyyy
  • dd.MM.yyyy
  • dd-MMM-yyyy
  • dd MMMM yyyy
  • M/d/yyyy
  • MM-dd-yyyy
  • MM/dd/yyyy
  • MM/dd/yy
  • MMM-dd-yyyy
  • MMM d, yyyy
  • MMMM d, yyyy
  • yyyy-MM-dd
  • yyyy-MMM-dd
  • yyyy/MM/dd
  • yyyy MMMM d

signDateFormatMetadatasettingsMetadata

Metadata that indicates whether the signDateFormat property is editable.

signTimeFormatstring

The format for the signature time. Valid values are:

  • none
  • HH:mm
  • h:mm
  • HH:mm:ss
  • h:mm:ss

signTimeFormatMetadatasettingsMetadata

Metadata that indicates whether the signTimeFormat property is editable.

timeFormatstring

timeFormatMetadatasettingsMetadata

timeZonestring

timeZoneMetadatasettingsMetadata

nameValue

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

namestring

The name or key of a name/value pair.

originalValuestring

The initial value of the tab when it was sent to the recipient.

valuestring

The value field of a name/value pair.

sealIdentifier

sealDisplayNamestring

sealNamestring

senderEmailNotifications

changedSignerstring

When set to true, the sender receives notification if the signer changes.

commentsOnlyPrivateAndMentionstring

When set to true, the user receives only comments in which that user name is mentioned.

commentsReceiveAllstring

When set to true, the user receives all comments.

deliveryFailedstring

When set to true, the sender receives notification if the delivery of the envelope fails.

envelopeCompletestring

When set to true, the user receives notification that the envelope has been completed.

offlineSigningFailedstring

When set to true, the user receives notification if the offline signing failed.

purgeDocumentsstring

When set to true, the user receives notification of document purges.

recipientViewedstring

When set to true, the sender receives notification that the recipient viewed the enveloper.

senderEnvelopeDeclinedstring

When set to true, the sender receives notification that the envelope was declined.

withdrawnConsentstring

When set to true, the user receives notification if consent is withdrawn.

settingsMetadata

Metadata that indicates whether a property is editable and describes setting-specific options.

is21CFRPart11string

When set to true, indicates that this module is enabled on the account.

options[array]

An array of option strings supported by this setting.

rightsstring

Indicates whether the property is editable. Valid values are:

  • editable
  • read_only

uiHintstring

Reserved for DocuSign.

uiOrderstring

Reserved for DocuSign.

uiTypestring

Reserved for DocuSign.

signerEmailNotifications

An array of email notifications that specifies the email the user receives when they are a sender. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created.

agentNotificationstring

When set to true, the user receives agent notification emails.

carbonCopyNotificationstring

When set to true, the user receives notifications of carbon copy deliveries.

certifiedDeliveryNotificationstring

When set to true, the user receives notifications of certified deliveries.

commentsOnlyPrivateAndMentionstring

When set to true, the user receives only comments in which that user name is mentioned.

commentsReceiveAllstring

When set to true, the user receives all comments.

documentMarkupActivationstring

When set to true, the user receives notification that document markup has been activated.

envelopeActivationstring

When set to true, the user receives notification that the envelope has been activated.

envelopeCompletestring

When set to true, the user receives notification that the envelope has been completed.

envelopeCorrectedstring

When set to true, the user receives notification that the envelope has been corrected.

envelopeDeclinedstring

When set to true, the user receives notification that the envelope has been declined.

envelopeVoidedstring

When set to true, the user receives notification that the envelope has been voided.

faxReceivedstring

Reserved for DocuSign.

offlineSigningFailedstring

When set to true, the user receives notification if the offline signing failed.

purgeDocumentsstring

When set to true, the user receives notification of document purges.

reassignedSignerstring

When set to true, the user receives notification that the envelope has been reassigned.

whenSigningGroupMemberstring

When set to true, the user receives notification that he or she is a member of the signing group.

userAccountManagementGranularInformation

Describes which account management capabilities a user has.

canManageAccountSecuritySettingsstring

True if the user can manage account security settings.

canManageAccountSecuritySettingsMetadatasettingsMetadata

canManageAccountSettingsstring

True if the user can manage account settings.

canManageAccountSettingsMetadatasettingsMetadata

canManageAdminsstring

True if the user can manage administrators.

canManageAdminsMetadatasettingsMetadata

Metadata that indicates whether the canManageAdmins property is editable.

canManageReportingstring

True if the user can manage reporting.

canManageReportingMetadatasettingsMetadata

canManageSharingstring

True if the user can manage sharing.

canManageSharingMetadatasettingsMetadata

Metadata that indicates whether the canManageSharing property is editable.

canManageSigningGroupsstring

True if the user can manage signing groups.

canManageSigningGroupsMetadatasettingsMetadata

canManageUsersstring

True if the user can manage users.

canManageUsersMetadatasettingsMetadata

Metadata that indicates whether the canManageUsers property is editable.

userInfo

accountIdstring

The external account number (int) or account ID GUID.

accountNamestring

The name of the account associated with the current workspace user.

activationAccessCodestring

Access code provided to the user to activate the account.

emailstring

Filters returned user records by the specified email address.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

loginStatusstring

Boolean value that indicates whether the user is currently logged in or not.

membershipIdstring

The user's membership ID.

sendActivationEmailstring

When set to true, specifies that an activation email be sent to the user.

uristring

URI containing the user ID.

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Administrator on the account, this can be another user the Admin user is accessing. Note: For Envelopes:listStatusChanges (GET /v2.1/accounts/{accountId}/envelopes), the user_id query parameter is not implemented and should not be used.

userNamestring

The name of the user.

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

userTypestring

The type of user, for example CompanyUser.

userSettingsInformation

Data that describes settings for a user. Some elements of this object have a metadata property, which includes the following:

  • rights: The calling users permissions to edit this setting (can be editable or read_only)
  • uiHint: Internally used to build UIs (can be available or hidden)
  • options: The values supported for this setting (not all settings have this element)

accountManagementGranularuserAccountManagementGranularInformation

Describes which account management capabilities a user has.

adminOnlystring

Reserved for DocuSign.

adminOnlyMetadatasettingsMetadata

Reserved for DocuSign.

allowEnvelopeTransferTostring

Boolean value that indicates whether the user can participate in envelope transfers on the account.

allowEnvelopeTransferToMetadatasettingsMetadata

Reserved for DocuSign.

allowEsealRecipientsstring

allowEsealRecipientsMetadatasettingsMetadata

allowPowerFormsAdminToAccessAllPowerFormEnvelopestring

allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadatasettingsMetadata

allowRecipientLanguageSelectionstring

When true, this user can set the language used in the standard email format for a recipient when creating an envelope.

allowRecipientLanguageSelectionMetadatasettingsMetadata

Metadata for allowRecipientLanguageSelection.

allowSendOnBehalfOfstring

When true, this user can send envelopes "on behalf of" other users through the API.

allowSendOnBehalfOfMetadatasettingsMetadata

Metadata for allowSendOnBehalfOf.

allowSupplementalDocumentsstring

When true, this user can use the supplemental documents feature.

allowSupplementalDocumentsMetadatasettingsMetadata

Metadata for allowSupplementalDocuments.

anchorTagVersionedPlacementEnabledstring

Valid values are:

  • system_default
  • off
  • on

apiAccountWideAccessstring

When true, indicates that this user can send envelope-specific API requests on the account.

apiAccountWideAccessMetadatasettingsMetadata

Metadata for apiAccountWideAccess.

apiCanExportACstring

When true, this user can export authoritative copy for the account.

apiCanExportACMetadatasettingsMetadata

bulkSendstring

When true, this user can use the bulk send feature for the account.

bulkSendMetadatasettingsMetadata

Metadata that indicates whether the bulkSend property is editable.

canChargeAccountstring

Reserved for DocuSign.

canChargeAccountMetadatasettingsMetadata

Reserved for DocuSign.

canEditSharedAddressbookstring

When true, this user can edit the shared address book for the account.

canEditSharedAddressbookMetadatasettingsMetadata

canLockEnvelopesstring

canLockEnvelopesMetadatasettingsMetadata

canManageAccountstring

When true, this user is an administrator for the account.

canManageAccountMetadatasettingsMetadata

canManageDistributorstring

Reserved for DocuSign.

canManageDistributorMetadatasettingsMetadata

canManageTemplatesstring

When true, this user can manage templates for the account.

canManageTemplatesMetadatasettingsMetadata

canSendAPIRequestsstring

When true, this user can send API requests on the account.

canSendAPIRequestsMetadatasettingsMetadata

canSendEnvelopestring

When true, this user can send envelopes on the account.

canSendEnvelopeMetadatasettingsMetadata

canSignEnvelopestring

When true, this user can sign envelopes.

canSignEnvelopeMetadatasettingsMetadata

canUseScratchpadstring

canUseScratchpadMetadatasettingsMetadata

disableDocumentUploadstring

When true, this user is prohibited from uploading documents during sending.

disableDocumentUploadMetadatasettingsMetadata

Metadata that indicates whether the disableDocumentUpload property is editable.

disableOtherActionsstring

disableOtherActionsMetadatasettingsMetadata

Metadata that indicates whether the disableOtherActions property is editable.

enableDSProstring

Reserved for DocuSign.

enableDSProMetadatasettingsMetadata

Metadata that indicates whether the enableDSPro property is editable.

enableSequentialSigningAPIstring

When true, the account can define the routing order of recipients for envelopes sent using the DocuSign API.

enableSequentialSigningAPIMetadatasettingsMetadata

Metadata that indicates whether the enableSequentialSigningAPI property is editable.

enableSequentialSigningUIstring

When true, the account can define the routing order of recipients for envelopes sent using the DocuSign application.

enableSequentialSigningUIMetadatasettingsMetadata

Metadata that indicates whether the enableSequentialSigningUI property is editable.

enableSignerAttachmentsstring

When true, this user can use the signing attachments feature.

enableSignerAttachmentsMetadatasettingsMetadata

Metadata that indicates whether the enableSignerAttachments property is editable.

enableSignOnPaperOverridestring

When true, this user can override the Sign on Paper account setting, which specifies whether signers can sign documents on paper as an option to signing electronically.

enableSignOnPaperOverrideMetadatasettingsMetadata

Metadata that indicates whether the enableSignOnPaperOverride property is editable.

enableTransactionPointstring

Reserved for DocuSign.

enableTransactionPointMetadatasettingsMetadata

Metadata that indicates whether the enableTransactionPoint property is editable.

enableVaultingstring

When true, Vaulting is enabled for the account.

enableVaultingMetadatasettingsMetadata

Metadata that indicates whether the enableVaulting property is editable.

expressSendOnlystring

localestring

The user's locale code:

  • zh_CN
  • zh_TW
  • nl
  • en
  • fr
  • de
  • it
  • ja
  • ko
  • pt
  • pt_BR
  • ru
  • es

localeMetadatasettingsMetadata

localePolicylocalePolicy

Reserved for DocuSign.

modifiedBystring

User ID (GUID) of the user who last modified this user record.

modifiedByMetadatasettingsMetadata

modifiedDatestring

Most recent date on which this user record was modified.

modifiedDateMetadatasettingsMetadata

modifiedPagestring

Note referencing the page that modified this user record.

modifiedPageMetadatasettingsMetadata

newSendUIstring

Reserved for DocuSign.

newSendUIMetadatasettingsMetadata

powerFormModestring

Indicates the Power Form mode setting for the user:

  • none
  • admin
  • user

powerFormModeMetadatasettingsMetadata

recipientViewedNotificationstring

When true, this user receives notifications when envelopes are viewed.

recipientViewedNotificationMetadatasettingsMetadata

sealIdentifiers[sealIdentifier]

selfSignedRecipientEmailDocumentstring

Valid values are:

  • include_pdf
  • include_link

selfSignedRecipientEmailDocumentMetadatasettingsMetadata

Metadata that indicates whether the selfSignedRecipientEmailDocument property is editable.

senderEmailNotificationssenderEmailNotifications

An array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from DocuSign.

The user inherits the default account sender email notification settings when the user is created. The email notifications are:

  • envelopeComplete
  • changedSigner
  • senderEnvelopeDeclined
  • withdrawnConsent
  • recipientViewed
  • deliveryFailed

signerEmailNotificationssignerEmailNotifications

An array of email notifications that specifies the email the user receives when they are a sender. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created.

supplementalDocumentIncludeInDownloadstring

When true, this user gets supplemental documents when downloading documents.

supplementalDocumentsMustAcceptstring

When true, this user must accept supplemental documents.

supplementalDocumentsMustAcceptMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustAccept property is editable.

supplementalDocumentsMustReadstring

When true, this user must read supplemental documents.

supplementalDocumentsMustReadMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustRead property is editable.

supplementalDocumentsMustViewstring

When true, this user must view supplemental documents.

supplementalDocumentsMustViewMetadatasettingsMetadata

Metadata that indicates whether the supplementalDocumentsMustView property is editable.

templateActiveCreationstring

templateActiveCreationMetadatasettingsMetadata

templateApplyNotifystring

templateApplyNotifyMetadatasettingsMetadata

templateAutoMatchingstring

templateAutoMatchingMetadatasettingsMetadata

templateMatchingSensitivitystring

Percentage used when matching templates.

templateMatchingSensitivityMetadatasettingsMetadata

templatePageLevelMatchingstring

When true, users see template matching functionality.

templatePageLevelMatchingMetadatasettingsMetadata

timezoneDSTstring

When true, daylight savings time is in effect for this user's time zone.

timezoneDSTMetadatasettingsMetadata

timezoneMaskstring

timezoneMaskMetadatasettingsMetadata

timezoneOffsetstring

The timezone offset for the user. Valid values:

  • tz_01_afghanistan
  • tz_02_alaskan
  • tz_03_arab
  • tz_04_arabian
  • tz_05_arabic
  • tz_06_argentina
  • tz_07_atlantic
  • tz_08_aus_central
  • tz_09_aus_eastern
  • tz_10_azerbaijan
  • tz_11_azores
  • tz_12_bangladesh
  • tz_13_canada_central
  • tz_14_cape_verde
  • tz_15_caucasus
  • tz_16_central_australia
  • tz_17_central_america
  • tz_18_central_asia
  • tz_19_central_brazilian
  • tz_20_central_europe
  • tz_21_central_european
  • tz_22_central_pacific
  • tz_23_central
  • tz_24_central_mexico
  • tz_25_china
  • tz_26_dateline
  • tz_27_east_africa
  • tz_28_east_australia
  • tz_29_east_europe
  • tz_30_east_south_america
  • tz_31_eastern
  • tz_32_egypt
  • tz_33_ekaterinburg
  • tz_34_fiji
  • tz_35_fli
  • tz_36_georgian
  • tz_37_gmt
  • tz_38_greenland
  • tz_39_greenwich
  • tz_40_gtb
  • tz_41_hawaiian
  • tz_42_india
  • tz_43_iran
  • tz_44_israel
  • tz_45_jordan
  • tz_46_kaliningrad
  • tz_47_kamchatka
  • tz_48_korea
  • tz_49_magadan
  • tz_50_mauritius
  • tz_51_mid_atlantic
  • tz_52_middle_east
  • tz_53_montevideo
  • tz_54_morocco
  • tz_55_mountain
  • tz_56_mountain_mexico
  • tz_57_myanmar
  • tz_58_north_central_asia
  • tz_59_namibia
  • tz_60_nepal
  • tz_61_new_zealand
  • tz_62_new_foundland
  • tz_63_north_asia_east
  • tz_64_north_asia
  • tz_65_pacific_sa
  • tz_66_pacific
  • tz_67_pacific_mexico
  • tz_68_pakistan
  • tz_69_paraguay
  • tz_70_romance
  • tz_71_russian
  • tz_72_sa_eastern
  • tz_73_sa_pacific
  • tz_74_sa_western
  • tz_75_samoa
  • tz_76_se_asia
  • tz_77_singapore
  • tz_78_south_africa
  • tz_79_sriLanka
  • tz_80_syria
  • tz_81_taipei
  • tz_82_tasmania
  • tz_83_tokyo
  • tz_84_tonga
  • tz_85_turkey
  • tz_86_ulaanbaatar
  • tz_87_us_eastern
  • tz_88_us_mountain
  • tz_89_venezuela
  • tz_90_vladivostok
  • tz_91_west_australia
  • tz_92_west_central_africa
  • tz_93_west_europe
  • tz_94_west_asia
  • tz_95_west_pacific
  • tz_96_yakutsk

timezoneOffsetMetadatasettingsMetadata

timezoneSendingPrefstring

Reserved for DocuSign.

timezoneSendingPrefMetadatasettingsMetadata

timezoneSigningPrefstring

Reserved for DocuSign.

timezoneSigningPrefMetadatasettingsMetadata

transactionPointSiteNameURLstring

Reserved for DocuSign.

transactionPointSiteNameURLMetadatasettingsMetadata

transactionPointUserNamestring

Reserved for DocuSign.

transactionPointUserNameMetadatasettingsMetadata

vaultingModestring

Indicates the specified Vaulting mode:

  • none
  • estored
  • electronic_original

vaultingModeMetadatasettingsMetadata

Metadata that indicates whether the vaultingMode property is editable.

Users

User management

activationAccessCodestring

The activation code a new user must enter when activating their account.

companystring

The name of the user's company.

connectConfigurations[connectUserObject]

Object representing the user's custom Connect configuration.

countryCodestring

The three-letter code for the user's country.

createdDateTimestring

The date and time the item was created.

customSettings[nameValue]

The name/value pair information for the user custom setting.

defaultAccountIdstring

The default account ID associated with the user.

emailstring

The user's email address.

enableConnectForUserstring

Boolean value that specifies whether the user is enabled for updates from DocuSign Connect.

errorDetailserrorDetails

Object that describes errors that occur. Only valid for responses; ignored in requests.

firstNamestring

The user's first name. Maximum Length: 50 characters.

forgottenPasswordInfoforgottenPasswordInformation

A complex element containing up to four Question/Answer pairs for forgotten password information.

groupList[group]

A list of the group information for groups to add the user to. Use UserGroups::listGroups to get information about groups.

When setting a user's group, only the groupId is required.

homeAddressaddressInformation

The user's physical home address.

initialsImageUristring

Contains the URI for an endpoint that you can use to retrieve the initials image.

isAdminstring

Determines if the feature set is actively set as part of the plan.

isNAREnabledstring

lastLoginstring

The date and time when the user last logged in to the system.

lastNamestring

The user's last name. Maximum Length: 50 characters.

loginStatusstring

Shows the current status of the user's password. Possible values are:

  • password_reset
  • password_active
  • password_expired
  • password_locked
  • password_reset_failed

middleNamestring

The user's middle name. Limit: 50 characters.

passwordstring

The user's password.

passwordExpirationstring

If password expiration is enabled, the date-time when the user's password expires.

permissionProfileIdstring

The id of the permission profile associated with the user.

permissionProfileNamestring

The name of the permission profile associated with the user.

profileImageUristring

The URL for retrieving the user's profile image.

sendActivationEmailstring

When set to true, specifies that an activation email be sent to the user.

sendActivationOnInvalidLoginstring

When set to true, specifies that an additional activation email be sent if user's log on fails before the account is activated.

signatureImageUristring

An endpoint URI that you can use to retrieve the user's signature image.

subscribestring

suffixNamestring

The suffix for the user's name, such as Jr, IV, PhD, etc.

Limit: 50 characters.

titlestring

The salutation for the user, such as Ms, Dr, Capt., etc.

Limit: 10 characters.

uristring

URI containing the user ID.

userAddedToAccountDateTimestring

The date and time that the user was added to the account.

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Administrator on the account, this can be another user the Admin user is accessing. Note: For Envelopes:listStatusChanges (GET /v2.1/accounts/{accountId}/envelopes), the user_id query parameter is not implemented and should not be used.

userNamestring

The user's full name.

userProfileLastModifiedDatestring

The date and time that the user's profile was last modified.

userSettingsuserSettingsInformation

The collection of settings representing the actions a user can perform. See userSettingsInformation for available settings.

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

userTypestring

The type of user, for example CompanyUser.

workAddressaddressInformation

The user's physical work address.

Examples

Generic JSON Response

Response
{
  "userName": "sample string 1",
  "userId": "sample string 2",
  "userType": "sample string 3",
  "isAdmin": "sample string 4",
  "userStatus": "sample string 5",
  "uri": "sample string 6",
  "email": "sample string 7",
  "password": "sample string 8",
  "title": "sample string 9",
  "createdDateTime": "sample string 10",
  "firstName": "sample string 11",
  "middleName": "sample string 12",
  "lastName": "sample string 13",
  "suffixName": "sample string 14",
  "permissionProfileId": "sample string 15",
  "permissionProfileName": "sample string 16",
  "countryCode": "sample string 17",
  "subscribe": "sample string 18",
  "userSettings": [
    {}
  ],
  "accountManagementGranular": {
    "canManageUsers": "sample string 1",
    "canManageAdmins": "sample string 2",
    "canManageGroups": "sample string 3",
    "canManageSharing": "sample string 4",
    "canManageUsersMetadata": {
      "rights": "sample string 1",
      "uiHint": "sample string 2",
      "uiType": "sample string 3",
      "uiOrder": "sample string 4",
      "is21CFRPart11": "sample string 5",
      "options": [
        "sample string 1"
      ]
    },
    "canManageAdminsMetadata": {},
    "canManageGroupsMetadata": {},
    "canManageSharingMetadata": {}
  },
  "sendActivationOnInvalidLogin": "sample string 19",
  "activationAccessCode": "sample string 20",
  "enableConnectForUser": "sample string 21",
  "forgottenPasswordInfo": {
    "forgottenPasswordQuestion1": "sample string 1",
    "forgottenPasswordAnswer1": "sample string 2",
    "forgottenPasswordQuestion2": "sample string 3",
    "forgottenPasswordAnswer2": "sample string 4",
    "forgottenPasswordQuestion3": "sample string 5",
    "forgottenPasswordAnswer3": "sample string 6",
    "forgottenPasswordQuestion4": "sample string 7",
    "forgottenPasswordAnswer4": "sample string 8"
  },
  "groupList": [
    {
      "groupId": "sample string 1",
      "groupName": "sample string 2",
      "permissionProfileId": "sample string 3",
      "groupType": "sample string 4",
      "users": [
        {
          "userName": "sample string 1",
          "userId": "sample string 2",
          "email": "sample string 3",
          "userType": "sample string 4",
          "userStatus": "sample string 5",
          "uri": "sample string 6",
          "loginStatus": "sample string 7",
          "sendActivationEmail": "sample string 8",
          "activationAccessCode": "sample string 9",
          "errorDetails": {
            "errorCode": "sample string 1",
            "message": "sample string 2"
          }
        }
      ],
      "errorDetails": {
        "errorCode": "SUCCESS",
        "message": ""
      }
    }
  ],
  "workAddress": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "city": "sample string 3",
    "stateOrProvince": "sample string 4",
    "postalCode": "sample string 5",
    "phone": "sample string 6",
    "fax": "sample string 7",
    "country": "sample string 8"
  },
  "homeAddress": {},
  "loginStatus": "sample string 22",
  "passwordExpiration": "sample string 23",
  "lastLogin": "sample string 24",
  "sendActivationEmail": "sample string 25",
  "errorDetails": {
    "errorCode": "SUCCESS",
    "message": ""
  },
  "customSettings": [
    {}
  ],
  "profileImageUri": "sample string 26",
  "userProfileLastModifiedDate": "sample string 27",
  "signatureImageUri": "sample string 28",
  "initialsImageUri": "sample string 29",
  "jobTitle": "sample string 30"
}
Generic XML Response

Response
<userInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <accountManagementGranular>
    <canManageAdmins>sample string 2</canManageAdmins>
    <canManageAdminsMetadata />
    <canManageGroups>sample string 3</canManageGroups>
    <canManageGroupsMetadata />
    <canManageSharing>sample string 4</canManageSharing>
    <canManageSharingMetadata />
    <canManageUsers>sample string 1</canManageUsers>
    <canManageUsersMetadata>
      <is21CFRPart11>sample string 5</is21CFRPart11>
      <options>
        <string>sample string 1</string>
      </options>
      <rights>sample string 1</rights>
      <uiHint>sample string 2</uiHint>
      <uiOrder>sample string 4</uiOrder>
      <uiType>sample string 3</uiType>
    </canManageUsersMetadata>
  </accountManagementGranular>
  <activationAccessCode>sample string 20</activationAccessCode>
  <countryCode>sample string 17</countryCode>
  <createdDateTime>sample string 10</createdDateTime>
  <customSettings>
    <nameValue />
  </customSettings>
  <email>sample string 7</email>
  <enableConnectForUser>sample string 21</enableConnectForUser>
  <errorDetails>
    <errorCode>SUCCESS</errorCode>
    <message></message>
  </errorDetails>
  <firstName>sample string 11</firstName>
  <forgottenPasswordInfo>
    <forgottenPasswordAnswer1>sample string 2</forgottenPasswordAnswer1>
    <forgottenPasswordAnswer2>sample string 4</forgottenPasswordAnswer2>
    <forgottenPasswordAnswer3>sample string 6</forgottenPasswordAnswer3>
    <forgottenPasswordAnswer4>sample string 8</forgottenPasswordAnswer4>
    <forgottenPasswordQuestion1>sample string 1</forgottenPasswordQuestion1>
    <forgottenPasswordQuestion2>sample string 3</forgottenPasswordQuestion2>
    <forgottenPasswordQuestion3>sample string 5</forgottenPasswordQuestion3>
    <forgottenPasswordQuestion4>sample string 7</forgottenPasswordQuestion4>
  </forgottenPasswordInfo>
  <groupList>
    <group>
      <errorDetails>
        <errorCode>SUCCESS</errorCode>
        <message></message>
      </errorDetails>
      <groupId>sample string 1</groupId>
      <groupName>sample string 2</groupName>
      <groupType>sample string 4</groupType>
      <permissionProfileId>sample string 3</permissionProfileId>
      <users>
        <userInfo>
          <activationAccessCode>sample string 9</activationAccessCode>
          <email>sample string 3</email>
          <errorDetails>
            <errorCode>sample string 1</errorCode>
            <message>sample string 2</message>
          </errorDetails>
          <loginStatus>sample string 7</loginStatus>
          <sendActivationEmail>sample string 8</sendActivationEmail>
          <uri>sample string 6</uri>
          <userId>sample string 2</userId>
          <userName>sample string 1</userName>
          <userStatus>sample string 5</userStatus>
          <userType>sample string 4</userType>
        </userInfo>
      </users>
    </group>
  </groupList>
  <homeAddress />
  <initialsImageUri>sample string 29</initialsImageUri>
  <isAdmin>sample string 4</isAdmin>
  <jobTitle>sample string 30</jobTitle>
  <lastLogin>sample string 24</lastLogin>
  <lastName>sample string 13</lastName>
  <loginStatus>sample string 22</loginStatus>
  <middleName>sample string 12</middleName>
  <password>sample string 8</password>
  <passwordExpiration>sample string 23</passwordExpiration>
  <permissionProfileId>sample string 15</permissionProfileId>
  <permissionProfileName>sample string 16</permissionProfileName>
  <profileImageUri>sample string 26</profileImageUri>
  <sendActivationEmail>sample string 25</sendActivationEmail>
  <sendActivationOnInvalidLogin>sample string 19</sendActivationOnInvalidLogin>
  <signatureImageUri>sample string 28</signatureImageUri>
  <subscribe>sample string 18</subscribe>
  <suffixName>sample string 14</suffixName>
  <title>sample string 9</title>
  <uri>sample string 6</uri>
  <userId>sample string 2</userId>
  <userName>sample string 1</userName>
  <userProfileLastModifiedDate>sample string 27</userProfileLastModifiedDate>
  <userSettings>
    <nameValue />
  </userSettings>
  <userStatus>sample string 5</userStatus>
  <userType>sample string 3</userType>
  <workAddress>
    <address1>sample string 1</address1>
    <address2>sample string 2</address2>
    <city>sample string 3</city>
    <country>sample string 8</country>
    <fax>sample string 7</fax>
    <phone>sample string 6</phone>
    <postalCode>sample string 5</postalCode>
    <stateOrProvince>sample string 4</stateOrProvince>
  </workAddress>
</userInformation> 
}} />