Skip to content

DocuSign: Gets the user account settings for a specified user

DocuSign esignature.esignatureUserSettingsGetUserSettings: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_usersettings_getusersettings

Provider route: GET /restapi/v2.1/accounts/{accountId}/users/{userId}/settings. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureUserSettingsGetUserSettings"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureUserSettingsGetUserSettings(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_user_settings_get_user_settings(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.userIdstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets the user account settings for a specified user — response body

Referenced models: Gets the user account settings for a specified user — response body

2 more schemas are linked from the tables above, on the schema pages.

Returns available seals for specified account — response body — seals item
FieldTypePresenceDescription and constraints
$objectRoot
sealDisplayNamestringOptionalThe user-friendly display name for a seal.
sealNamestringOptionalThe name of a seal.
Gets the user account settings for a specified user — response body — sender Email Notifications
FieldTypePresenceDescription and constraints
$objectRootContains the settings for the email notifications that senders receive about the envelopes that they send.
changedSignerstringOptionalWhen **true,** the sender receives an email notification if the signer changes.
clickwrapResponsesLimitNotificationEmailstringOptional
commentsOnlyPrivateAndMentionstringOptionalWhen **true,** the user receives only comments that mention their own user name.
commentsReceiveAllstringOptionalWhen **true,** the user receives all comments.
deliveryFailedstringOptionalWhen **true,** the sender receives an email notification if envelope delivery fails.
envelopeCompletestringOptionalWhen **true,** the user receives an email notification when the envelope has been completed.
offlineSigningFailedstringOptionalWhen **true,** the user receives an email notification if offline signing failed.
powerformResponsesLimitNotificationEmailstringOptional
purgeDocumentsstringOptionalWhen **true,** the user receives an email notification when a document purge occurs.
recipientViewedstringOptionalWhen **true,** the sender receives notification that a recipient viewed the envelope.
senderEnvelopeDeclinedstringOptionalWhen **true,** the sender receives notification that the envelope was declined.
withdrawnConsentstringOptionalWhen **true,** the user receives an email notification if consent is withdrawn.
Gets the user account settings for a specified user — response body — locale Metadata
FieldTypePresenceDescription and constraints
$objectRootMetadata that indicates whether a property is editable and describes setting-specific options.
is21CFRPart11stringOptionalWhen **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES).
optionsarrayOptionalAn array of option strings supported by this setting.
options[]stringEach item
rightsstringOptionalIndicates whether the property is editable. Valid values are:

- `editable`
- `read_only`
uiHintstringOptionalReserved for Docusign.
uiOrderstringOptionalReserved for Docusign.
uiTypestringOptionalReserved for Docusign.
Gets the user account settings for a specified user — response body — signer Email Notifications
FieldTypePresenceDescription and constraints
$objectRootAn array of email notifications that specifies the email the user receives when they are a recipient. 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 email notification settings when the user is created.
agentNotificationstringOptionalWhen **true,** the user receives agent notification emails.
carbonCopyNotificationstringOptionalWhen **true,** the user receives notifications of carbon copy deliveries.
certifiedDeliveryNotificationstringOptionalWhen **true,** the user receives notifications of certified deliveries.
commentsOnlyPrivateAndMentionstringOptionalWhen **true,** the user receives only comments that mention their own user name.
commentsReceiveAllstringOptionalWhen **true,** the user receives all comments.
documentMarkupActivationstringOptionalWhen **true,** the user receives notification that document markup has been activated.
envelopeActivationstringOptionalWhen **true,** the user receives notification that the envelope has been activated.
envelopeCompletestringOptionalWhen **true,** the user receives an email notification when the envelope has been completed.
envelopeCorrectedstringOptionalWhen **true,** the user receives notification that the envelope has been corrected.
envelopeDeclinedstringOptionalWhen **true,** the user receives notification that the envelope has been declined.
envelopeVoidedstringOptionalWhen **true,** the user receives notification that the envelope has been voided.
faxReceivedstringOptionalReserved for Docusign.
offlineSigningFailedstringOptionalWhen **true,** the user receives an email notification if offline signing failed.
purgeDocumentsstringOptionalWhen **true,** the user receives an email notification when a document purge occurs.
reassignedSignerstringOptionalWhen **true,** the user receives notification that the envelope has been reassigned.
whenSigningGroupMemberstringOptionalWhen **true,** the user receives notification that he or she is a member of the signing group.
Gets the user account settings for a specified user — response body — account Management Granular
FieldTypePresenceDescription and constraints
$objectRootDescribes which account management capabilities a user has.
canManageAccountSecuritySettingsstringOptional**True** if the user can manage account security settings.
canManageAccountSecuritySettingsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageAccountSettingsstringOptional**True** if the user can manage account settings.
canManageAccountSettingsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageAdminsstringOptional**True** if the user can manage administrators.
canManageAdminsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `canManageAdmins` property is editable.
canManageConnectstringOptional
canManageConnectMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageDocumentRetentionstringOptional
canManageDocumentRetentionMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageEnvelopeTransferstringOptional
canManageEnvelopeTransferMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageGroupsButNotUsersstringOptional
canManageGroupsButNotUsersMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageJointAgreementsstringOptional
canManageJointAgreementsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageReportingstringOptional**True** if the user can manage reporting.
canManageReportingMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageSharingstringOptional**True** if the user can manage sharing.
canManageSharingMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `canManageSharing` property is editable.
canManageSigningGroupsstringOptional**True** if the user can manage signing groups.
canManageSigningGroupsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageStampsstringOptional
canManageStampsMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
canManageUsersstringOptional**True** if the user can manage users.
canManageUsersMetadataModelOptionalExpand Gets the user account settings for a specified user — response body — locale Metadata
Metadata that indicates whether the `canManageUsers` property is editable.
canViewUsersstringOptional

Referenced models: Gets the user account settings for a specified user — response body — locale Metadata

SDK function policy ID: docusign.esignature_usersettings_getusersettings. Catalog operation: esignature:UserSettings_GetUserSettings. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.