Updates the password rules for an account
This method updates the password rules for an account.
Note: To update the password rules for an account, you must be an account administrator.
Authorization
OAuth2 OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.
In: header
Path Parameters
The external account number (int) or account ID GUID.
Request Body
application/json
When true, passwords expire. The default value is false.
The number of days before passwords expire. To use this property, the expirePassword property must be set to true.
The number of minutes a user is locked out of the system after three failed login attempts. The default value is 2.
The interval associated with the user lockout after a failed login attempt.
Possible values are:
minutes(default)hoursdays
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.
The minimum number of characters in the password. This value must be a number between 6 and 15. The default value is 6.
When true, passwords must include a digit. The default value is false.
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.
When true, passwords must include a lowercase letter. The default value is false.
When true, passwords must include a special character. The default value is false.
Note: Passwords cannot include angle brackets (< >) or spaces.
When true, passwords must include an uppercase letter. The default value is false.
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:minimumPasswordLengthminimumPasswordAgeDayspasswordIncludeDigitpasswordIncludeDigitOrSpecialCharacterpasswordIncludeLowerCasepasswordIncludeSpecialCharacterpasswordIncludeUpperCasequestionsRequired
The number of security questions required to confirm the user’s identity before the user can reset their password. The default value is 0.
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.
Response Body
application/json
application/json
curl -X PUT "https://example.com/v2.1/accounts/string/settings/password_rules" \ -H "Content-Type: application/json" \ -d '{}'{ "expirePassword": "string", "expirePasswordDays": "string", "expirePasswordDaysMetadata": { "maximumDays": "string", "minimumDays": "string" }, "lockoutDurationMinutes": "string", "lockoutDurationMinutesMetadata": { "maximumMinutes": "string", "minimumMinutes": "string" }, "lockoutDurationType": "string", "lockoutDurationTypeMetadata": { "options": [ "string" ] }, "minimumPasswordAgeDays": "string", "minimumPasswordAgeDaysMetadata": { "maximumAge": "string", "minimumAge": "string" }, "minimumPasswordLength": "string", "minimumPasswordLengthMetadata": { "maximumLength": "string", "minimumLength": "string" }, "passwordIncludeDigit": "string", "passwordIncludeDigitOrSpecialCharacter": "string", "passwordIncludeLowerCase": "string", "passwordIncludeSpecialCharacter": "string", "passwordIncludeUpperCase": "string", "passwordStrengthType": "string", "passwordStrengthTypeMetadata": { "options": [ { "minimumLength": "string", "name": "string", "passwordIncludeDigit": "string", "passwordIncludeDigitOrSpecialCharacter": "string", "passwordIncludeLowerCase": "string", "passwordIncludeSpecialCharacter": "string", "passwordIncludeUpperCase": "string" } ] }, "questionsRequired": "string", "questionsRequiredMetadata": { "maximumQuestions": "string", "minimumQuestions": "string" }}