DocuSign: Gets membership account password rules
DocuSign esignature.esignaturePasswordRulesGetPasswordRules: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_passwordrules_getpasswordrules
Provider route: GET /restapi/v2.1/current_user/password_rules. 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"]["esignaturePasswordRulesGetPasswordRules"]>[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.esignaturePasswordRulesGetPasswordRules(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_password_rules_get_password_rules(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
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 membership account password rules — response body |
Referenced models: Gets membership account password rules — response body
Schemas
Section titled “Schemas”1 more schema is linked from the tables above, on the schema pages.
Gets membership account password rules — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains details about the password rules for a user. |
passwordRules | Model | Optional | Expand Gets the password rules for an account — response body Contains details about the password rules for the user. |
userId | string | Optional | 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. |
Referenced models: Gets the password rules for an account — response body
Gets the password rules for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expirePassword | string | Optional | When **true,** passwords expire. The default value is `false`. |
expirePasswordDays | string | Optional | The number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true.** |
expirePasswordDaysMetadata | Model | Optional | Expand Gets the password rules for an account — response body — expire Password Days Metadata Metadata that indicates whether the `expirePasswordDays` property is editable. |
lockoutDurationMinutes | string | Optional | The number of minutes a user is locked out of the system after three failed login attempts. The default value is `2`. |
lockoutDurationMinutesMetadata | Model | Optional | Expand Gets the password rules for an account — response body — lockout Duration Minutes Metadata Metadata that indicates whether the `lockoutDurationMinutes` property is editable. |
lockoutDurationType | string | Optional | The interval associated with the user lockout after a failed login attempt. Possible values are: - `minutes` (default) - `hours` - `days` |
lockoutDurationTypeMetadata | Model | Optional | Expand Gets the password rules for an account — response body — lockout Duration Type Metadata Metadata that indicates whether the `lockoutDurationType` property is editable. |
minimumPasswordAgeDays | string | Optional | The 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`. |
minimumPasswordAgeDaysMetadata | Model | Optional | Expand Gets the password rules for an account — response body — minimum Password Age Days Metadata Metadata that indicates whether the `minimumPasswordAgeDays` property is editable. |
minimumPasswordLength | string | Optional | The minimum number of characters in the password. This value must be a number between `6` and `15`. The default value is `6`. |
minimumPasswordLengthMetadata | Model | Optional | Expand Gets the password rules for an account — response body — minimum Password Length Metadata Metadata that indicates whether the `minimumPasswordLength` property is editable. |
passwordIncludeDigit | string | Optional | When **true,** passwords must include a digit. The default value is `false`. |
passwordIncludeDigitOrSpecialCharacter | string | Optional | When **true,** passwords must include either a digit or a special character. The default value is `false`. **Note:** Passwords cannot include angle brackets (`<` `>`) or spaces. |
passwordIncludeLowerCase | string | Optional | When **true,** passwords must include a lowercase letter. The default value is `false`. |
passwordIncludeSpecialCharacter | string | Optional | When **true,** passwords must include a special character. The default value is `false`. **Note:** Passwords cannot include angle brackets (`<` `>`) or spaces. |
passwordIncludeUpperCase | string | Optional | When **true,** passwords must include an uppercase letter. The default value is `false`. |
passwordStrengthType | string | Optional | The 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` |
passwordStrengthTypeMetadata | Model | Optional | Expand Gets the password rules for an account — response body — password Strength Type Metadata Metadata that indicates whether the `passwordStrengthType` property is editable. |
questionsRequired | string | Optional | The number of security questions required to confirm the user’s identity before the user can reset their password. The default value is `0`. |
questionsRequiredMetadata | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
maximumLength | string | Optional | The maximum number of entry characters supported by the custom tab. |
minimumLength | string | Optional | Minimum length of the access code string. |
Gets the password rules for an account — response body — expire Password Days Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
maximumDays | string | Optional | |
minimumDays | string | Optional |
Gets the password rules for an account — response body — lockout Duration Minutes Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
maximumMinutes | string | Optional | |
minimumMinutes | string | Optional |
Gets the password rules for an account — response body — lockout Duration Type Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
options | array | Optional | An array of option strings supported by this setting. |
options[] | string | Each item |
Gets the password rules for an account — response body — minimum Password Age Days Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
maximumAge | string | Optional | |
minimumAge | string | Optional |
Gets the password rules for an account — response body — questions Required Metadata
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password. |
maximumQuestions | string | Optional | The 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`. |
minimumQuestions | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
options | array | Optional | An array of option strings supported by this setting. |
options[] | Model | Each item | Expand 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
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_passwordrules_getpasswordrules. Catalog operation: esignature:PasswordRules_GetPasswordRules. 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.