Get password policy

Request syntax

Example

> GET /v1/authentication/passwordPolicy

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 45992

{
  "passwordAttemptsAllowed": 5,
  "minChars": 8,
  "minUpperCaseChars": 1,
  "minLowerCaseChars": 1,
  "minNumericChars": 1,
  "minSpecialChars": 0,
  "maxIdenticalConsecutiveChars": 0,
  "maxPasswordAge": null,
  "minPasswordAge": null,
  "uniquePasswords": null
}

Attributes

passwordAttemptsAllowed (number)

The number of invalid password attempts allowed before a user account is locked.

minChars (number)

The minimum number of characters required for a new password. Valid values range from 8 to 30.

minUpperCaseChars (number)

The minimum number of uppercase characters (A–Z) required for new passwords. Valid values range from 0 to 3.

minLowerCaseChars (number)

The minimum number of lowercase characters (a–z) required for new passwords. Valid values range from 0 to 3.

minNumericChars (number)

The minimum number of numeric characters (0–9) required for new passwords. Valid values range from 0 to 3.

minSpecialChars (number)

The Minimum number of special characters (! @ # $ %) required for new passwords. Valid values range from 0 to 3.

maxIdenticalConsecutiveChars (number)

The maximum number of identical consecutive characters that are allowed for new passwords. Valid values range from 0 to 3.

maxPasswordAge (number)

The number of days it takes for a user’s password to expire after it is set. Valid values range from 1 to 365. The value can be set to null to disable password expiration.

minPasswordAge (number)

The number of days that must pass before a password can be modified by the user. Valid values range from 1 to 365. The value can be set to null to disable this requirement.

uniquePasswords (number)

The number of unique passwords required before a password can be reused. Valid values range from 1 to 8. The value can be set to null to disable this requirement.