Request

HTTP request

GET /v2.1/current_user/password_rules

Parameters

Parameter NameValueDescription

Responses

CodeDescriptionReference
200

Successful response.

userPasswordRules
400

Error encountered.

errorDetails

SDK Method

Accounts::getPasswordRules

Definitions

accountMinimumPasswordLength

maximumLengthstring

minimumLengthstring

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

namestring

passwordIncludeDigitstring

passwordIncludeDigitOrSpecialCharacterstring

passwordIncludeLowerCasestring

passwordIncludeSpecialCharacterstring

passwordIncludeUpperCasestring

errorDetails

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

errorCodestring

A code associated with the error condition.

messagestring

A brief message describing the error condition.

userPasswordRules

passwordRulesAccountPasswordRules

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Administrator on the account, this can be another user the Admin user is accessing. Note: For Envelopes:listStatusChanges (GET /v2.1/accounts/{accountId}/envelopes), the user_id query parameter is not implemented and should not be used.

AccountPasswordRules

expirePasswordstring

expirePasswordDaysstring

expirePasswordDaysMetadataaccountPasswordExpirePasswordDays

Metadata that indicates whether the expirePasswordDays property is editable.

lockoutDurationMinutesstring

lockoutDurationMinutesMetadataaccountPasswordLockoutDurationMinutes

Metadata that indicates whether the lockoutDurationMinutes property is editable.

lockoutDurationTypestring

lockoutDurationTypeMetadataaccountPasswordLockoutDurationType

Metadata that indicates whether the lockoutDurationType property is editable.

minimumPasswordAgeDaysstring

minimumPasswordAgeDaysMetadataaccountPasswordMinimumPasswordAgeDays

Metadata that indicates whether the minimumPasswordAgeDays property is editable.

minimumPasswordLengthstring

minimumPasswordLengthMetadataaccountMinimumPasswordLength

Metadata that indicates whether the minimumPasswordLength property is editable.

passwordIncludeDigitstring

passwordIncludeDigitOrSpecialCharacterstring

passwordIncludeLowerCasestring

passwordIncludeSpecialCharacterstring

passwordIncludeUpperCasestring

passwordStrengthTypestring

passwordStrengthTypeMetadataaccountPasswordStrengthType

Metadata that indicates whether the passwordStrengthType property is editable.

questionsRequiredstring

questionsRequiredMetadataaccountPasswordQuestionsRequired

Metadata that indicates whether the questionsRequired property is editable.

Examples

Generic JSON Response

Response
{
  "passwordRules": {
    "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"
    }
  },
  "userId": "sample string 1"
}
Generic XML Response

Response
<userPasswordRules xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <passwordRules>
    <expirePassword>sample string 2</expirePassword>
    <expirePasswordDays>sample string 3</expirePasswordDays>
    <expirePasswordDaysMetadata xmlns:d3p1="http://www.docusign.com">
      <d3p1:maximumDays>sample string 2</d3p1:maximumDays>
      <d3p1:minimumDays>sample string 1</d3p1: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>
  </passwordRules>
  <userId>sample string 1</userId>
</userPasswordRules> 
}} />