Users: getSettings

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 about the different user settings, see User Settings.

Request

HTTP request

GET /v2/accounts/{accountId}/users/{userId}/settings

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 Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

Responses

CodeDescriptionReference
200

Successful response.

userSettingsInformation
400

Error encountered.

errorDetails

SDK Method

Users::getSettings

Definitions

errorDetails

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

errorCodestring

An error code associated with the error.

messagestring

A short error message.

nameValue

errorDetailserrorDetails

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.

senderEmailNotifications

changedSignerstring

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

commentsOnlyPrivateAndMentionstring

commentsReceiveAllstring

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.

recipientViewedstring

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

senderEnvelopeDeclinedstring

withdrawnConsentstring

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

settingsMetadata

is21CFRPart11string

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

options[array]

rightsstring

uiHintstring

uiOrderstring

uiTypestring

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

commentsReceiveAllstring

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:

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

userAccountManagementGranularInformation

Describes which account management capabilities a user has.

canManageAccountSecuritySettingsstring

canManageAccountSecuritySettingsMetadatasettingsMetadata

canManageAccountSettingsstring

canManageAccountSettingsMetadatasettingsMetadata

canManageAdminsstring

True if the user can manage admins.

canManageAdminsMetadatasettingsMetadata

canManageGroupsstring

True if the user can manage groups.

canManageGroupsMetadatasettingsMetadata

canManageReportingstring

canManageReportingMetadatasettingsMetadata

canManageSharingstring

canManageSharingMetadatasettingsMetadata

canManageSigningGroupsstring

canManageSigningGroupsMetadatasettingsMetadata

canManageUsersstring

True if the user can manage users.

canManageUsersMetadatasettingsMetadata

userSettingsInformation

accountManagementGranularuserAccountManagementGranularInformation

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.

userSettings[nameValue]

Examples

Generic JSON Response

Response
{
  "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": {}
  },
  "signerEmailNotifications": {
    "envelopeActivation": "sample string 1",
    "envelopeComplete": "sample string 2",
    "carbonCopyNotification": "sample string 3",
    "certifiedDeliveryNotification": "sample string 4",
    "envelopeDeclined": "sample string 5",
    "envelopeVoided": "sample string 6",
    "envelopeCorrected": "sample string 7",
    "reassignedSigner": "sample string 8",
    "purgeDocuments": "sample string 9",
    "faxReceived": "sample string 10",
    "documentMarkupActivation": "sample string 11",
    "agentNotification": "sample string 12",
    "offlineSigningFailed": "sample string 13",
    "whenSigningGroupMember": "sample string 14",
    "commentsReceiveAll": "sample string 15",
    "commentsOnlyPrivateAndMention": "sample string 16"
  },
  "senderEmailNotifications": {
    "envelopeComplete": "sample string 1",
    "changedSigner": "sample string 2",
    "senderEnvelopeDeclined": "sample string 3",
    "withdrawnConsent": "sample string 4",
    "recipientViewed": "sample string 5",
    "deliveryFailed": "sample string 6",
    "offlineSigningFailed": "sample string 7",
    "commentsReceiveAll": "sample string 8",
    "commentsOnlyPrivateAndMention": "sample string 9"
  }
}
Generic XML Response

Response
<userSettingsInformation 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>
  <senderEmailNotifications>
    <changedSigner>sample string 2</changedSigner>
    <commentsOnlyPrivateAndMention>sample string 9</commentsOnlyPrivateAndMention>
    <commentsReceiveAll>sample string 8</commentsReceiveAll>
    <deliveryFailed>sample string 6</deliveryFailed>
    <envelopeComplete>sample string 1</envelopeComplete>
    <offlineSigningFailed>sample string 7</offlineSigningFailed>
    <recipientViewed>sample string 5</recipientViewed>
    <senderEnvelopeDeclined>sample string 3</senderEnvelopeDeclined>
    <withdrawnConsent>sample string 4</withdrawnConsent>
  </senderEmailNotifications>
  <signerEmailNotifications>
    <agentNotification>sample string 12</agentNotification>
    <carbonCopyNotification>sample string 3</carbonCopyNotification>
    <certifiedDeliveryNotification>sample string 4</certifiedDeliveryNotification>
    <commentsOnlyPrivateAndMention>sample string 16</commentsOnlyPrivateAndMention>
    <commentsReceiveAll>sample string 15</commentsReceiveAll>
    <documentMarkupActivation>sample string 11</documentMarkupActivation>
    <envelopeActivation>sample string 1</envelopeActivation>
    <envelopeComplete>sample string 2</envelopeComplete>
    <envelopeCorrected>sample string 7</envelopeCorrected>
    <envelopeDeclined>sample string 5</envelopeDeclined>
    <envelopeVoided>sample string 6</envelopeVoided>
    <faxReceived>sample string 10</faxReceived>
    <offlineSigningFailed>sample string 13</offlineSigningFailed>
    <purgeDocuments>sample string 9</purgeDocuments>
    <reassignedSigner>sample string 8</reassignedSigner>
    <whenSigningGroupMember>sample string 14</whenSigningGroupMember>
  </signerEmailNotifications>
  <userSettings>
    <nameValue />
  </userSettings>
</userSettingsInformation> 
}} />