Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
passwordPolicy

Get the current password policy.

Get the current password policy.

get/v1/passwordPolicy

Response

The current password policy.

minLengthinteger

The minimum length of the password.

maxLengthinteger

The maximum length of the password. (Setting this to any value other than 128 is no longer supported; this field may be deprecated in the future.)

mustContainLowercaseboolean

If the password must contain lower case characters.

mustContainUppercaseboolean

If the password must contain upper case characters.

mustContainDigitsboolean

If the password must contain digits.

mustContainSpecialCharsboolean

If the password must contain special characters.

maxPasswordAgeInDaysinteger

Maximum number of days that a password can be used before user is required to change it. Put -1 if the user should not have to change their password.

minUniquePasswordsinteger

The minimum number of unique new passwords that a user must use before an old password can be reused.

accountLockoutThresholdinteger

Number of failed login attempts allowed before account is locked-out.

failedLoginResetDurationInMinsinteger

The duration of time in minutes that must elapse from the first failed login attempt after which failed login count is reset to 0.

accountLockoutDurationInMinsinteger

The duration of time in minutes that a locked-out account remained locked before getting unlocked automatically.

requireMfaboolean

If MFA should be required to log in. By default, this field is set to false.

rememberMfaboolean

If MFA should be remembered on the browser.

disallowWeakPasswordsboolean

If weak passwords should be disallowed. By default, this field is set to false.

Example response

{
  "minLength": 8,
  "maxLength": 128,
  "mustContainLowercase": true,
  "mustContainUppercase": true,
  "mustContainDigits": true,
  "mustContainSpecialChars": true,
  "maxPasswordAgeInDays": 365,
  "minUniquePasswords": 10,
  "accountLockoutThreshold": 6,
  "failedLoginResetDurationInMins": 10,
  "accountLockoutDurationInMins": 30,
  "rememberMfa": true
}