Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
AccountPasswordRules

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.

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

Path parameters

accountIdstring required

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

Request body

expirePasswordstring

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

lockoutDurationMinutesstring

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

lockoutDurationTypestring

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

Possible values are:

  • minutes (default)
  • hours
  • days
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.

minimumPasswordLengthstring

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

passwordIncludeDigitstring

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

passwordIncludeDigitOrSpecialCharacterstring

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.

passwordIncludeLowerCasestring

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

passwordIncludeSpecialCharacterstring

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

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

passwordIncludeUpperCasestring

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

Response

Successful response.