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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
path.userId | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Gets the user account settings for a specified user — response body |
Referenced models: Gets the user account settings for a specified user — response body
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
Returns available seals for specified account — response body — seals item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
sealDisplayName | string | Optional | The user-friendly display name for a seal. |
sealName | string | Optional | The name of a seal. |
Gets the user account settings for a specified user — response body — sender Email Notifications
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the settings for the email notifications that senders receive about the envelopes that they send. |
changedSigner | string | Optional | When **true,** the sender receives an email notification if the signer changes. |
clickwrapResponsesLimitNotificationEmail | string | Optional | |
commentsOnlyPrivateAndMention | string | Optional | When **true,** the user receives only comments that mention their own user name. |
commentsReceiveAll | string | Optional | When **true,** the user receives all comments. |
deliveryFailed | string | Optional | When **true,** the sender receives an email notification if envelope delivery fails. |
envelopeComplete | string | Optional | When **true,** the user receives an email notification when the envelope has been completed. |
offlineSigningFailed | string | Optional | When **true,** the user receives an email notification if offline signing failed. |
powerformResponsesLimitNotificationEmail | string | Optional | |
purgeDocuments | string | Optional | When **true,** the user receives an email notification when a document purge occurs. |
recipientViewed | string | Optional | When **true,** the sender receives notification that a recipient viewed the envelope. |
senderEnvelopeDeclined | string | Optional | When **true,** the sender receives notification that the envelope was declined. |
withdrawnConsent | string | Optional | When **true,** the user receives an email notification if consent is withdrawn. |
Gets the user account settings for a specified user — response body — locale Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Metadata that indicates whether a property is editable and describes setting-specific options. |
is21CFRPart11 | string | Optional | When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). |
options | array | Optional | An array of option strings supported by this setting. |
options[] | string | Each item | |
rights | string | Optional | Indicates whether the property is editable. Valid values are: - `editable` - `read_only` |
uiHint | string | Optional | Reserved for Docusign. |
uiOrder | string | Optional | Reserved for Docusign. |
uiType | string | Optional | Reserved for Docusign. |
Gets the user account settings for a specified user — response body — signer Email Notifications
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An 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. |
agentNotification | string | Optional | When **true,** the user receives agent notification emails. |
carbonCopyNotification | string | Optional | When **true,** the user receives notifications of carbon copy deliveries. |
certifiedDeliveryNotification | string | Optional | When **true,** the user receives notifications of certified deliveries. |
commentsOnlyPrivateAndMention | string | Optional | When **true,** the user receives only comments that mention their own user name. |
commentsReceiveAll | string | Optional | When **true,** the user receives all comments. |
documentMarkupActivation | string | Optional | When **true,** the user receives notification that document markup has been activated. |
envelopeActivation | string | Optional | When **true,** the user receives notification that the envelope has been activated. |
envelopeComplete | string | Optional | When **true,** the user receives an email notification when the envelope has been completed. |
envelopeCorrected | string | Optional | When **true,** the user receives notification that the envelope has been corrected. |
envelopeDeclined | string | Optional | When **true,** the user receives notification that the envelope has been declined. |
envelopeVoided | string | Optional | When **true,** the user receives notification that the envelope has been voided. |
faxReceived | string | Optional | Reserved for Docusign. |
offlineSigningFailed | string | Optional | When **true,** the user receives an email notification if offline signing failed. |
purgeDocuments | string | Optional | When **true,** the user receives an email notification when a document purge occurs. |
reassignedSigner | string | Optional | When **true,** the user receives notification that the envelope has been reassigned. |
whenSigningGroupMember | string | Optional | When **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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Describes which account management capabilities a user has. |
canManageAccountSecuritySettings | string | Optional | **True** if the user can manage account security settings. |
canManageAccountSecuritySettingsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageAccountSettings | string | Optional | **True** if the user can manage account settings. |
canManageAccountSettingsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageAdmins | string | Optional | **True** if the user can manage administrators. |
canManageAdminsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `canManageAdmins` property is editable. |
canManageConnect | string | Optional | |
canManageConnectMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageDocumentRetention | string | Optional | |
canManageDocumentRetentionMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageEnvelopeTransfer | string | Optional | |
canManageEnvelopeTransferMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageGroupsButNotUsers | string | Optional | |
canManageGroupsButNotUsersMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageJointAgreements | string | Optional | |
canManageJointAgreementsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageReporting | string | Optional | **True** if the user can manage reporting. |
canManageReportingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageSharing | string | Optional | **True** if the user can manage sharing. |
canManageSharingMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `canManageSharing` property is editable. |
canManageSigningGroups | string | Optional | **True** if the user can manage signing groups. |
canManageSigningGroupsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageStamps | string | Optional | |
canManageStampsMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata |
canManageUsers | string | Optional | **True** if the user can manage users. |
canManageUsersMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `canManageUsers` property is editable. |
canViewUsers | string | Optional |
Referenced models: Gets the user account settings for a specified user — response body — locale Metadata
Policy, approvals and errors
Section titled “Policy, approvals and errors”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.