This method retrieves the password rules for an account.

Request

HTTP request

GET /v2.1/accounts/{accountId}/settings/password_rules

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

Responses

CodeDescriptionReference
200

Successful response.

AccountPasswordRules
400

Error encountered.

errorDetails

SDK Method

Accounts::getAccountPasswordRules

Definitions

accountMinimumPasswordLength

maximumLengthstring

minimumLengthstring

Minimum length of the access code string.

accountPasswordExpirePasswordDays

maximumDaysstring

minimumDaysstring

accountPasswordLockoutDurationMinutes

maximumMinutesstring

minimumMinutesstring

accountPasswordLockoutDurationType

options[array]

An array of option strings supported by this setting.

accountPasswordMinimumPasswordAgeDays

maximumAgestring

minimumAgestring

accountPasswordQuestionsRequired

maximumQuestionsstring

minimumQuestionsstring

accountPasswordStrengthType

options[accountPasswordStrengthTypeOption]

An array of option strings supported by this setting.

accountPasswordStrengthTypeOption

minimumLengthstring

Minimum length of the access code string.

namestring

passwordIncludeDigitstring

When set to true, passwords must include a digit. The default value is false.

passwordIncludeDigitOrSpecialCharacterstring

When set to true, passwords must include either a digit or a special character. The default value is false.

Note: Passwords cannot include angle brackets (< >) or spaces.

passwordIncludeLowerCasestring

When set to true, passwords must include a lowercase letter. The default value is false.

passwordIncludeSpecialCharacterstring

When set to true, passwords must include a special character. The default value is false.

Note: Passwords cannot include angle brackets (< >) or spaces.

passwordIncludeUpperCasestring

When set to true, passwords must include an uppercase letter. The default value is false.

errorDetails

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

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

AccountPasswordRules

Contains details about the password rules for an account.

expirePasswordstring

When set to true, passwords expire. The default value is false.

expirePasswordDaysstring

The number of days before passwords expire. To use this property, the expirePassword property must be set to true.

expirePasswordDaysMetadataaccountPasswordExpirePasswordDays

Metadata that indicates whether the expirePasswordDays property is editable.

lockoutDurationMinutesstring

The number of minutes a user is locked out of the system after three (?) failed login attempts. The default value is 2.

lockoutDurationMinutesMetadataaccountPasswordLockoutDurationMinutes

Metadata that indicates whether the lockoutDurationMinutes property is editable.

lockoutDurationTypestring

The interval associated with the user lockout after a failed login attempt.

Possible values are: (?????)

  • minutes (default)
  • hours
  • days

lockoutDurationTypeMetadataaccountPasswordLockoutDurationType

Metadata that indicates whether the lockoutDurationType property is editable.

minimumPasswordAgeDaysstring

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.

minimumPasswordAgeDaysMetadataaccountPasswordMinimumPasswordAgeDays

Metadata that indicates whether the minimumPasswordAgeDays property is editable.

minimumPasswordLengthstring

The minimum number of characters in the password. This value must be a number between 6 and 15. The default value is 6.

minimumPasswordLengthMetadataaccountMinimumPasswordLength

Metadata that indicates whether the minimumPasswordLength property is editable.

passwordIncludeDigitstring

When set to true, passwords must include a digit. The default value is false.

passwordIncludeDigitOrSpecialCharacterstring

When set to true, passwords must include either a digit or a special character. The default value is false.

Note: Passwords cannot include angle brackets (< >) or spaces.

passwordIncludeLowerCasestring

When set to true, passwords must include a lowercase letter. The default value is false.

passwordIncludeSpecialCharacterstring

When set to true, passwords must include a special character. The default value is false.

Note: Passwords cannot include angle brackets (< >) or spaces.

passwordIncludeUpperCasestring

When set to true, passwords must include an uppercase letter. The default value is false.

passwordStrengthTypestring

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

passwordStrengthTypeMetadataaccountPasswordStrengthType

Metadata that indicates whether the passwordStrengthType property is editable.

questionsRequiredstring

The number of security questions required to confirm the user’s identity before the user can reset their password. The default value is 0.

questionsRequiredMetadataaccountPasswordQuestionsRequired

Metadata that indicates whether the questionsRequired property is editable.

Examples

Generic JSON Response

Response
{
  "passwordStrengthType": "sample string 1",
  "passwordStrengthTypeMetadata": {
    "options": [
      {
        "name": "sample string 1",
        "minimumLength": "sample string 2",
        "passwordIncludeUpperCase": "sample string 3",
        "passwordIncludeLowerCase": "sample string 4",
        "passwordIncludeDigit": "sample string 5",
        "passwordIncludeSpecialCharacter": "sample string 6",
        "passwordIncludeDigitOrSpecialCharacter": "sample string 7"
      }
    ]
  },
  "expirePassword": "sample string 2",
  "expirePasswordDays": "sample string 3",
  "expirePasswordDaysMetadata": {
    "minimumDays": "sample string 1",
    "maximumDays": "sample string 2"
  },
  "minimumPasswordLength": "sample string 4",
  "minimumPasswordLengthMetadata": {
    "minimumLength": "sample string 1",
    "maximumLength": "sample string 2"
  },
  "minimumPasswordAgeDays": "sample string 5",
  "minimumPasswordAgeDaysMetadata": {
    "minimumAge": "sample string 1",
    "maximumAge": "sample string 2"
  },
  "lockoutDurationType": "sample string 6",
  "lockoutDurationTypeMetadata": {
    "options": [
      "sample string 1"
    ]
  },
  "lockoutDurationMinutes": "sample string 7",
  "lockoutDurationMinutesMetadata": {
    "minimumMinutes": "sample string 1",
    "maximumMinutes": "sample string 2"
  },
  "passwordIncludeUpperCase": "sample string 8",
  "passwordIncludeLowerCase": "sample string 9",
  "passwordIncludeDigit": "sample string 10",
  "passwordIncludeSpecialCharacter": "sample string 11",
  "passwordIncludeDigitOrSpecialCharacter": "sample string 12",
  "questionsRequired": "sample string 13",
  "questionsRequiredMetadata": {
    "minimumQuestions": "sample string 1",
    "maximumQuestions": "sample string 2"
  }
}
Generic XML Response

Response
<accountPasswordRules xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <expirePassword>sample string 2</expirePassword>
  <expirePasswordDays>sample string 3</expirePasswordDays>
  <expirePasswordDaysMetadata xmlns:d2p1="http://www.docusign.com">
    <d2p1:maximumDays>sample string 2</d2p1:maximumDays>
    <d2p1:minimumDays>sample string 1</d2p1:minimumDays>
  </expirePasswordDaysMetadata>
  <lockoutDurationMinutes>sample string 7</lockoutDurationMinutes>
  <lockoutDurationMinutesMetadata>
    <maximumMinutes>sample string 2</maximumMinutes>
    <minimumMinutes>sample string 1</minimumMinutes>
  </lockoutDurationMinutesMetadata>
  <lockoutDurationType>sample string 6</lockoutDurationType>
  <lockoutDurationTypeMetadata>
    <options>
      <string>sample string 1</string>
    </options>
  </lockoutDurationTypeMetadata>
  <minimumPasswordAgeDays>sample string 5</minimumPasswordAgeDays>
  <minimumPasswordAgeDaysMetadata>
    <maximumAge>sample string 2</maximumAge>
    <minimumAge>sample string 1</minimumAge>
  </minimumPasswordAgeDaysMetadata>
  <minimumPasswordLength>sample string 4</minimumPasswordLength>
  <minimumPasswordLengthMetadata>
    <maximumLength>sample string 2</maximumLength>
    <minimumLength>sample string 1</minimumLength>
  </minimumPasswordLengthMetadata>
  <passwordIncludeDigit>sample string 10</passwordIncludeDigit>
  <passwordIncludeDigitOrSpecialCharacter>sample string 12</passwordIncludeDigitOrSpecialCharacter>
  <passwordIncludeLowerCase>sample string 9</passwordIncludeLowerCase>
  <passwordIncludeSpecialCharacter>sample string 11</passwordIncludeSpecialCharacter>
  <passwordIncludeUpperCase>sample string 8</passwordIncludeUpperCase>
  <passwordStrengthType>sample string 1</passwordStrengthType>
  <passwordStrengthTypeMetadata>
    <options>
      <accountPasswordStrengthTypeOption>
        <minimumLength>sample string 2</minimumLength>
        <name>sample string 1</name>
        <passwordIncludeDigit>sample string 5</passwordIncludeDigit>
        <passwordIncludeDigitOrSpecialCharacter>sample string 7</passwordIncludeDigitOrSpecialCharacter>
        <passwordIncludeLowerCase>sample string 4</passwordIncludeLowerCase>
        <passwordIncludeSpecialCharacter>sample string 6</passwordIncludeSpecialCharacter>
        <passwordIncludeUpperCase>sample string 3</passwordIncludeUpperCase>
      </accountPasswordStrengthTypeOption>
    </options>
  </passwordStrengthTypeMetadata>
  <questionsRequired>sample string 13</questionsRequired>
  <questionsRequiredMetadata>
    <maximumQuestions>sample string 2</maximumQuestions>
    <minimumQuestions>sample string 1</minimumQuestions>
  </questionsRequiredMetadata>
</accountPasswordRules> 
}} />