Users
Gets the user account settings for a specified user
Retrieves a list of the account settings and email notification information for the specified user.
The response returns the account setting name/value information and the email notification settings for the specified user. For more information, see Users:create.
Authorization
OAuth2 AuthorizationBearer <token>
OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
accountId*string
The external account number (int) or account ID GUID.
userId*string
The ID of the user to access.
Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.
Response Body
application/json
application/json
curl -X GET "https://example.com/v2.1/accounts/string/users/string/settings"{ "accountAgreementsAccessType": "string", "accountManagementGranular": { "canManageAccountSecuritySettings": "string", "canManageAccountSettings": "string", "canManageAdmins": "string", "canManageConnect": "string", "canManageDocumentRetention": "string", "canManageEnvelopeTransfer": "string", "canManageGroupsButNotUsers": "string", "canManageJointAgreements": "string", "canManageReporting": "string", "canManageSharing": "string", "canManageSigningGroups": "string", "canManageStamps": "string", "canManageUsers": "string", "canViewUsers": "string" }, "adminOnly": "string", "allowAccessToAllAccountAgreements": "string", "allowAutoTagging": "string", "allowedDocumentTemplateLibraryAccess": "string", "allowedOrchestrationAccess": "string", "allowEnvelopeTransferTo": "string", "allowEsealRecipients": "string", "allowPowerFormsAdminToAccessAllPowerFormEnvelope": "string", "allowRecipientLanguageSelection": "string", "allowSendOnBehalfOf": "string", "allowSupplementalDocuments": "string", "allowTransactions": "string", "anchorTagVersionedPlacementEnabled": "string", "apiAccountWideAccess": "string", "apiCanExportAC": "string", "bulkSend": "string", "canBulkUploadAgreements": "string", "canChargeAccount": "string", "canCreateTransaction": "string", "canDeleteDocumentsInTransaction": "string", "canDeleteTransaction": "string", "canEditSharedAddressbook": "string", "canLockEnvelopes": "string", "canManageAccount": "string", "canManageAgreementParties": "string", "canManageDistributor": "string", "canManageTemplates": "string", "canSendAPIRequests": "string", "canSendEnvelope": "string", "canSendEnvelopesViaSMS": "string", "canSignEnvelope": "string", "canUseScratchpad": "string", "canUseSmartContracts": "string", "disableDocumentUpload": "string", "disableOtherActions": "string", "enableDSPro": "string", "enableKeyTermsSuggestionsByDocumentType": "string", "enableSequentialSigningAPI": "string", "enableSequentialSigningUI": "string", "enableSignerAttachments": "string", "enableSignOnPaperOverride": "string", "enableTransactionPoint": "string", "enableVaulting": "string", "expressSendOnly": "string", "isManagedByScim": "string", "isMembershipManagedByScim": "string", "locale": "string", "localePolicy": { "addressFormat": "string", "allowRegion": "string", "calendarType": "string", "cultureName": "string", "currencyCode": "string", "currencyNegativeFormat": "string", "currencyPositiveFormat": "string", "customDateFormat": "string", "customSignDateFormat": "string", "customSignTimeFormat": "string", "customTimeFormat": "string", "dateFormat": "string", "effectiveAddressFormat": "string", "effectiveCalendarType": "string", "effectiveCurrencyCode": "string", "effectiveCurrencyNegativeFormat": "string", "effectiveCurrencyPositiveFormat": "string", "effectiveCustomDateFormat": "string", "effectiveCustomTimeFormat": "string", "effectiveDateFormat": "string", "effectiveInitialFormat": "string", "effectiveNameFormat": "string", "effectiveTimeFormat": "string", "effectiveTimeZone": "string", "initialFormat": "string", "nameFormat": "string", "signDateFormat": "string", "signTimeFormat": "string", "timeFormat": "string", "timeZone": "string" }, "manageClickwrapsMode": "string", "modifiedBy": "string", "modifiedDate": "string", "modifiedPage": "string", "newSendUI": "string", "powerFormMode": "string", "recipientViewedNotification": "string", "sealIdentifiers": [ { "sealDisplayName": "string", "sealName": "string" } ], "selfSignedRecipientEmailDocument": "string", "senderEmailNotifications": { "changedSigner": "string", "clickwrapResponsesLimitNotificationEmail": "string", "commentsOnlyPrivateAndMention": "string", "commentsReceiveAll": "string", "deliveryFailed": "string", "envelopeComplete": "string", "offlineSigningFailed": "string", "powerformResponsesLimitNotificationEmail": "string", "purgeDocuments": "string", "recipientViewed": "string", "senderEnvelopeDeclined": "string", "withdrawnConsent": "string" }, "signerEmailNotifications": { "agentNotification": "string", "carbonCopyNotification": "string", "certifiedDeliveryNotification": "string", "commentsOnlyPrivateAndMention": "string", "commentsReceiveAll": "string", "documentMarkupActivation": "string", "envelopeActivation": "string", "envelopeComplete": "string", "envelopeCorrected": "string", "envelopeDeclined": "string", "envelopeVoided": "string", "faxReceived": "string", "offlineSigningFailed": "string", "purgeDocuments": "string", "reassignedSigner": "string", "whenSigningGroupMember": "string" }, "supplementalDocumentIncludeInDownload": "string", "supplementalDocumentsMustAccept": "string", "supplementalDocumentsMustRead": "string", "supplementalDocumentsMustView": "string", "templateActiveCreation": "string", "templateApplyNotify": "string", "templateAutoMatching": "string", "templateMatchingSensitivity": "string", "templatePageLevelMatching": "string", "timezoneDST": "string", "timezoneMask": "string", "timezoneOffset": "string", "timezoneSendingPref": "string", "timezoneSigningPref": "string", "transactionPointSiteNameURL": "string", "transactionPointUserName": "string", "vaultingMode": "string", "webForms": "string"}Updates the user profile image for a specified user PUT
Updates the user profile image by uploading an image to the user profile. The supported image formats are: gif, png, jpeg, and bmp. The file must be less than 200K. For best viewing results, Docusign recommends that the image is no more than 79 pixels wide and high.
Updates the user account settings for a specified user PUT
Updates the account settings list and email notification types for the specified user.