Skip to content

DocuSign: Gets the password rules for an account

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

← Esignature operations · Get started

Operation docusign.esignature_accountpasswordrules_getaccountpasswordrules

Provider route: GET /restapi/v2.1/accounts/{accountId}/settings/password_rules. 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"]["esignatureAccountPasswordRulesGetAccountPasswordRules"]>[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.esignatureAccountPasswordRulesGetAccountPasswordRules(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_account_password_rules_get_account_password_rules(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

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 password rules for an account — response body

Referenced models: Gets the password rules for an account — response body

Gets the password rules for an account — response body
FieldTypePresenceDescription and constraints
$objectRoot
expirePasswordstringOptionalWhen **true,** passwords expire. The default value is `false`.
expirePasswordDaysstringOptionalThe number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true.**
expirePasswordDaysMetadataModelOptionalExpand Gets the password rules for an account — response body — expire Password Days Metadata
Metadata that indicates whether the `expirePasswordDays` property is editable.
lockoutDurationMinutesstringOptionalThe number of minutes a user is locked out of the system after three failed login attempts. The default value is `2`.
lockoutDurationMinutesMetadataModelOptionalExpand Gets the password rules for an account — response body — lockout Duration Minutes Metadata
Metadata that indicates whether the `lockoutDurationMinutes` property is editable.
lockoutDurationTypestringOptionalThe interval associated with the user lockout after a failed login attempt.

Possible values are:

- `minutes` (default)
- `hours`
- `days`
lockoutDurationTypeMetadataModelOptionalExpand Gets the password rules for an account — response body — lockout Duration Type Metadata
Metadata that indicates whether the `lockoutDurationType` property is editable.
minimumPasswordAgeDaysstringOptionalThe minimum number of days after a password is set before it can be changed. This value can be `0` or more days. The default value is `0`.
minimumPasswordAgeDaysMetadataModelOptionalExpand Gets the password rules for an account — response body — minimum Password Age Days Metadata
Metadata that indicates whether the `minimumPasswordAgeDays` property is editable.
minimumPasswordLengthstringOptionalThe minimum number of characters in the password. This value must be a number between `6` and `15`. The default value is `6`.
minimumPasswordLengthMetadataModelOptionalExpand Gets the password rules for an account — response body — minimum Password Length Metadata
Metadata that indicates whether the `minimumPasswordLength` property is editable.
passwordIncludeDigitstringOptionalWhen **true,** passwords must include a digit. The default value is `false`.
passwordIncludeDigitOrSpecialCharacterstringOptionalWhen **true,** passwords must include either a digit or a special character. The default value is `false`.

**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces.
passwordIncludeLowerCasestringOptionalWhen **true,** passwords must include a lowercase letter. The default value is `false`.
passwordIncludeSpecialCharacterstringOptionalWhen **true,** passwords must include a special character. The default value is `false`.

**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces.
passwordIncludeUpperCasestringOptionalWhen **true,** passwords must include an uppercase letter. The default value is `false`.
passwordStrengthTypestringOptionalThe type of password strength. Possible values are:

- `basic`: The minimum password length is 6 characters with no other password requirements.
- `medium`: The minimum password length is 7 characters. Passwords must also have one uppercase letter, one lowercase letter, and one number or special character.
- `strong`: The minimum password length is 9 characters. Passwords must also have one uppercase letter, one lowercase letter, one number, and one special character.
- `custom`: This option enables you to customize password requirements, including the following properties:

- `minimumPasswordLength`
- `minimumPasswordAgeDays`
- `passwordIncludeDigit`
- `passwordIncludeDigitOrSpecialCharacter`
- `passwordIncludeLowerCase`
- `passwordIncludeSpecialCharacter`
- `passwordIncludeUpperCase`
- `questionsRequired`
passwordStrengthTypeMetadataModelOptionalExpand Gets the password rules for an account — response body — password Strength Type Metadata
Metadata that indicates whether the `passwordStrengthType` property is editable.
questionsRequiredstringOptionalThe number of security questions required to confirm the user’s identity before the user can reset their password. The default value is `0`.
questionsRequiredMetadataModelOptionalExpand Gets the password rules for an account — response body — questions Required Metadata
Metadata that indicates whether the `questionsRequired` property is editable.

Referenced models: Gets the password rules for an account — response body — minimum Password Length Metadata, Gets the password rules for an account — response body — expire Password Days Metadata, Gets the password rules for an account — response body — lockout Duration Minutes Metadata, Gets the password rules for an account — response body — lockout Duration Type Metadata, Gets the password rules for an account — response body — minimum Password Age Days Metadata, Gets the password rules for an account — response body — questions Required Metadata, Gets the password rules for an account — response body — password Strength Type Metadata

Gets the password rules for an account — response body — minimum Password Length Metadata
FieldTypePresenceDescription and constraints
$objectRoot
maximumLengthstringOptionalThe maximum number of entry characters supported by the custom tab.
minimumLengthstringOptionalMinimum length of the access code string.
Gets the password rules for an account — response body — expire Password Days Metadata
FieldTypePresenceDescription and constraints
$objectRoot
maximumDaysstringOptional
minimumDaysstringOptional
Gets the password rules for an account — response body — lockout Duration Minutes Metadata
FieldTypePresenceDescription and constraints
$objectRoot
maximumMinutesstringOptional
minimumMinutesstringOptional
Gets the password rules for an account — response body — lockout Duration Type Metadata
FieldTypePresenceDescription and constraints
$objectRoot
optionsarrayOptionalAn array of option strings supported by this setting.
options[]stringEach item
Gets the password rules for an account — response body — minimum Password Age Days Metadata
FieldTypePresenceDescription and constraints
$objectRoot
maximumAgestringOptional
minimumAgestringOptional
Gets the password rules for an account — response body — questions Required Metadata
FieldTypePresenceDescription and constraints
$objectRootInformation about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password.
maximumQuestionsstringOptionalThe maximum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or greater than `minimumQuestions`.
minimumQuestionsstringOptionalThe minimum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or less than `maximumQuestions`.
Gets the password rules for an account — response body — password Strength Type Metadata
FieldTypePresenceDescription and constraints
$objectRoot
optionsarrayOptionalAn array of option strings supported by this setting.
options[]ModelEach itemExpand Gets the password rules for an account — response body — password Strength Type Metadata options item

Referenced models: Gets the password rules for an account — response body — password Strength Type Metadata options item

Gets the password rules for an account — response body — password Strength Type Metadata options item
FieldTypePresenceDescription and constraints
$objectRoot
minimumLengthstringOptionalMinimum length of the access code string.
namestringOptional
passwordIncludeDigitstringOptionalWhen **true,** passwords must include a digit. The default value is `false`.
passwordIncludeDigitOrSpecialCharacterstringOptionalWhen **true,** passwords must include either a digit or a special character. The default value is `false`.

**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces.
passwordIncludeLowerCasestringOptionalWhen **true,** passwords must include a lowercase letter. The default value is `false`.
passwordIncludeSpecialCharacterstringOptionalWhen **true,** passwords must include a special character. The default value is `false`.

**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces.
passwordIncludeUpperCasestringOptionalWhen **true,** passwords must include an uppercase letter. The default value is `false`.

SDK function policy ID: docusign.esignature_accountpasswordrules_getaccountpasswordrules. Catalog operation: esignature:AccountPasswordRules_GetAccountPasswordRules. 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.