Skip to content

Latest commit

 

History

History
128 lines (124 loc) · 16.7 KB

UserSettingsInformation.md

File metadata and controls

128 lines (124 loc) · 16.7 KB

UserSettingsInformation

Properties

Name Type Description Notes
accountManagementGranular UserAccountManagementGranularInformation [optional]
adminOnly String Reserved for DocuSign. [optional]
adminOnlyMetadata SettingsMetadata [optional]
allowAutoTagging String When set to true, the API returns suggested tabs for documents for this user. [optional]
allowEnvelopeTransferTo String When set to true, this user can participate in envelope transfers on the account. [optional]
allowEnvelopeTransferToMetadata SettingsMetadata [optional]
allowEsealRecipients String When set to true, this user can create [electronic seal recipients][eseal]. [eseal]: /esign/restapi//Envelopes/EnvelopeRecipients#seal-recipient [optional]
allowEsealRecipientsMetadata SettingsMetadata [optional]
allowPowerFormsAdminToAccessAllPowerFormEnvelope String When set to true and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is false. [optional]
allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata SettingsMetadata [optional]
allowRecipientLanguageSelection String When set to true, this user can set the language used in the standard email format for a recipient when creating an envelope. [optional]
allowRecipientLanguageSelectionMetadata SettingsMetadata [optional]
allowSendOnBehalfOf String When set to true, this user can send envelopes "on behalf of" other users through the API. [optional]
allowSendOnBehalfOfMetadata SettingsMetadata [optional]
allowSupplementalDocuments String When true, this user can include supplemental documents. [optional]
allowSupplementalDocumentsMetadata SettingsMetadata [optional]
anchorTagVersionedPlacementEnabled String Reserved for DocuSign. [optional]
apiAccountWideAccess String When true, indicates that this user can send envelope-specific API requests on the account. [optional]
apiAccountWideAccessMetadata SettingsMetadata [optional]
apiCanExportAC String When true, this user can export authoritative copy for the account. [optional]
apiCanExportACMetadata SettingsMetadata [optional]
bulkSend String When true, this user can use the bulk send feature for the account. [optional]
bulkSendMetadata SettingsMetadata [optional]
canChargeAccount String Reserved for DocuSign. [optional]
canChargeAccountMetadata SettingsMetadata [optional]
canEditSharedAddressbook String When true, this user can edit the shared address book for the account. [optional]
canEditSharedAddressbookMetadata SettingsMetadata [optional]
canLockEnvelopes String When set to true, this user can lock envelopes. [optional]
canLockEnvelopesMetadata SettingsMetadata [optional]
canManageAccount String When true, this user is an administrator for the account. [optional]
canManageAccountMetadata SettingsMetadata [optional]
canManageDistributor String Reserved for DocuSign. [optional]
canManageDistributorMetadata SettingsMetadata [optional]
canManageTemplates String When true, this user can manage templates for the account. [optional]
canManageTemplatesMetadata SettingsMetadata [optional]
canSendAPIRequests String When true, this user can send API requests on the account. [optional]
canSendAPIRequestsMetadata SettingsMetadata [optional]
canSendEnvelope String When true, this user can send envelopes on the account. [optional]
canSendEnvelopeMetadata SettingsMetadata [optional]
canSignEnvelope String When true, this user can sign envelopes. [optional]
canSignEnvelopeMetadata SettingsMetadata [optional]
canUseScratchpad String When set to true, this user can use a scratchpad to edit information. [optional]
canUseScratchpadMetadata SettingsMetadata [optional]
canUseSmartContracts String Reserved for DocuSign. [optional]
canUseSmartContractsMetadata SettingsMetadata [optional]
disableDocumentUpload String When true, this user is prohibited from uploading documents during sending. [optional]
disableDocumentUploadMetadata SettingsMetadata [optional]
disableOtherActions String When true, this user can access the Other Actions menu. [optional]
disableOtherActionsMetadata SettingsMetadata [optional]
enableDSPro String Reserved for DocuSign. [optional]
enableDSProMetadata SettingsMetadata [optional]
enableSequentialSigningAPI String When set to true, the account can define the routing order of recipients for envelopes sent by using the eSignature API. Note: Only SysAdmin users can change this setting. [optional]
enableSequentialSigningAPIMetadata SettingsMetadata [optional]
enableSequentialSigningUI String When set to true, the account can define the routing order of recipients for envelopes sent by using the DocuSign application. Note: Only SysAdmin users can change this setting. [optional]
enableSequentialSigningUIMetadata SettingsMetadata [optional]
enableSignerAttachments String When true, this user can use the signing attachments feature. [optional]
enableSignerAttachmentsMetadata SettingsMetadata [optional]
enableSignOnPaperOverride String When set to true, a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically. Note: Only Admin users can change this setting. [optional]
enableSignOnPaperOverrideMetadata SettingsMetadata [optional]
enableTransactionPoint String Reserved for DocuSign. [optional]
enableTransactionPointMetadata SettingsMetadata [optional]
enableVaulting String When set to true, Vaulting is enabled for the account. [optional]
enableVaultingMetadata SettingsMetadata [optional]
expressSendOnly String When set to false, this user can apply tabs to documents during the sending experience. [optional]
locale String The user's locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` - `es` [optional]
localeMetadata SettingsMetadata [optional]
localePolicy LocalePolicy [optional]
manageClickwrapsMode String When set to true, this user can create and manage Clickwraps. [optional]
manageClickwrapsModeMetadata SettingsMetadata [optional]
modifiedBy String The user id (GUID) of the user who last modified this user record. [optional]
modifiedByMetadata SettingsMetadata [optional]
modifiedDate String The date on which this user record was last modified. [optional]
modifiedDateMetadata SettingsMetadata [optional]
modifiedPage String Note referencing the page that modified this user record. [optional]
modifiedPageMetadata SettingsMetadata [optional]
newSendUI String Reserved for DocuSign. [optional]
newSendUIMetadata SettingsMetadata [optional]
powerFormMode String Indicates the Power Form mode setting for the user: - `none` - `admin` - `user` [optional]
powerFormModeMetadata SettingsMetadata [optional]
recipientViewedNotification String When true, this user receives notifications when envelopes are viewed. [optional]
recipientViewedNotificationMetadata SettingsMetadata [optional]
sealIdentifiers [SealIdentifier] Information about the seals associated with this user. [optional]
selfSignedRecipientEmailDocument String Sets how self-signed documents are presented to the email recipients. Valid values are: - `include_pdf`: A PDF of the completed document is attached to the email. - `include_link`: A secure link to the self-signed documents is included in the email. Note: Only Admin users can change this setting. [optional]
selfSignedRecipientEmailDocumentMetadata SettingsMetadata [optional]
senderEmailNotifications SenderEmailNotifications [optional]
signerEmailNotifications SignerEmailNotifications [optional]
supplementalDocumentIncludeInDownload String When true, this user gets supplemental documents when downloading documents. [optional]
supplementalDocumentsMustAccept String When true, this user must accept supplemental documents. [optional]
supplementalDocumentsMustAcceptMetadata SettingsMetadata [optional]
supplementalDocumentsMustRead String When true, this user must both view and accept supplemental documents. [optional]
supplementalDocumentsMustReadMetadata SettingsMetadata [optional]
supplementalDocumentsMustView String When true, this user must view supplemental documents. [optional]
supplementalDocumentsMustViewMetadata SettingsMetadata [optional]
templateActiveCreation String When set to true, a new template is created each time the user sends an envelope. [optional]
templateActiveCreationMetadata SettingsMetadata [optional]
templateApplyNotify String When set to true, the system notifies this user before applying a matching template. [optional]
templateApplyNotifyMetadata SettingsMetadata [optional]
templateAutoMatching String When set to true, the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from. [optional]
templateAutoMatchingMetadata SettingsMetadata [optional]
templateMatchingSensitivity String Percentage used when matching templates. [optional]
templateMatchingSensitivityMetadata SettingsMetadata [optional]
templatePageLevelMatching String When true, users see template matching functionality. [optional]
templatePageLevelMatchingMetadata SettingsMetadata [optional]
timezoneDST String When true, daylight savings time is in effect for this user's time zone. [optional]
timezoneDSTMetadata SettingsMetadata [optional]
timezoneMask String The custom DateTime format setting for this user. [optional]
timezoneMaskMetadata SettingsMetadata [optional]
timezoneOffset String 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` [optional]
timezoneOffsetMetadata SettingsMetadata [optional]
timezoneSendingPref String Reserved for DocuSign. [optional]
timezoneSendingPrefMetadata SettingsMetadata [optional]
timezoneSigningPref String Reserved for DocuSign. [optional]
timezoneSigningPrefMetadata SettingsMetadata [optional]
transactionPointSiteNameURL String Reserved for DocuSign. [optional]
transactionPointSiteNameURLMetadata SettingsMetadata [optional]
transactionPointUserName String Reserved for DocuSign. [optional]
transactionPointUserNameMetadata SettingsMetadata [optional]
vaultingMode String Indicates the specified Vaulting mode: - `none` - `estored` - `electronic_original` [optional]
vaultingModeMetadata SettingsMetadata [optional]

[Back to Model list] [Back to API list] [Back to README]