Request

HTTP request

PUT /v2/accounts/{accountId}/settings/password_rules

Parameters

Parameter name Value Description
Path parameters
accountId string

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

Request Body

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

Accounts::updatePasswordRules

Definitions Expand All | Collapse All

AccountPasswordRules

expirePassword string
expirePasswordDays string
expirePasswordDaysMetadata accountPasswordExpirePasswordDays
lockoutDurationMinutes string
lockoutDurationMinutesMetadata accountPasswordLockoutDurationMinutes
lockoutDurationType string
lockoutDurationTypeMetadata accountPasswordLockoutDurationType
minimumPasswordAgeDays string
minimumPasswordAgeDaysMetadata accountPasswordMinimumPasswordAgeDays
minimumPasswordLength string
minimumPasswordLengthMetadata accountMinimumPasswordLength
passwordIncludeDigit string
passwordIncludeDigitOrSpecialCharacter string
passwordIncludeLowerCase string
passwordIncludeSpecialCharacter string
passwordIncludeUpperCase string
passwordStrengthType string
passwordStrengthTypeMetadata accountPasswordStrengthType
questionsRequired string
questionsRequiredMetadata accountPasswordQuestionsRequired

accountMinimumPasswordLength

maximumLength string
minimumLength string

accountPasswordExpirePasswordDays

maximumDays string
minimumDays string

accountPasswordLockoutDurationMinutes

maximumMinutes string
minimumMinutes string

accountPasswordLockoutDurationType

options
[string]

accountPasswordMinimumPasswordAgeDays

maximumAge string
minimumAge string

accountPasswordQuestionsRequired

maximumQuestions string
minimumQuestions string

accountPasswordStrengthType

accountPasswordStrengthTypeOption

minimumLength string
name string
passwordIncludeDigit string
passwordIncludeDigitOrSpecialCharacter string
passwordIncludeLowerCase string
passwordIncludeSpecialCharacter string
passwordIncludeUpperCase string

errorDetails

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

errorCode string

An error code associated with the error.

message string

A short error message.

Examples

Generic JSON Request/Response

Request

{
"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"
}
}

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 Request/Response

Request

<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>

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>