About this Resource

Modified: for 3.1.0

Defines the Global User Security Options which defines password complexity requirements and password lifetime.

REST API Methods for this Resource

Resource Schema

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
ConfigIEStateNoYesEnum1Possible values:
  • 0 - esDISABLED
  • 1 - esENABLED
Specifies the Administrative State of the resource.
EnhPassSecurityNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether to enforce password security requirements.
MinPassLenYesNoint8Possible values:
  • 6 - Minimum
  • 16 - Maximum
Specifies the minimum allowed password length.
MinPassUpperYesNoint1Possible values:
  • 1 - Minimum
  • 4 - Maximum
Specifies the minimum number of upper case characters which must exist in the password.
MinPassLowerYesNoint1Possible values:
  • 0 - Minimum
  • 4 - Maximum
Specifies the minimum number of lower case characters which must exist in the password.
MinPassDigitsYesNoint1Possible values:
  • 0 - Minimum
  • 4 - Maximum
Specifies the minimum number of digits which must exist in the password.
MinPassSpecialYesNoint1Possible values:
  • 0 - Minimum
  • 4 - Maximum
Specifies the minimum number of special characters which must exist in the password.
MinPassDeltaYesNoint1Possible values:
  • 1 - Minimum
  • 8 - Maximum
Specifies the minimum number of characters that must be different than previous password.
MaxPassConsecYesNoEnum0Possible values:
  • 0 - eNoRestriction
  • 1 - eOne
  • 2 - eTwo
  • 3 - eThree
  • 4 - eFour
Specifies the maximum number of identical consecutive characters allowed in the password.
SetPasswordLifeNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether to enforce password lifetime.
MaxPassLifeYesNoint180Possible values:
  • 30 - Minimum
  • 365 - Maximum
Specifies the number of days since last password change that current password will expire.
NumFailedLoginsForLockoutYesNoint3Possible values:
  • 0 - Minimum
  • 10 - Maximum
Specifies the number of failed consecutive login attempts before user will be temporarily locked out.
LockoutDurationYesNoint5Possible values:
  • 1 - Minimum
  • 120 - Maximum
Specifies the lockout duration (in minutes) for a user with too many failed login attempts.
PasswordRecoveryNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether password recovery is enabled. (Used when all administrator user passwords are forgotten)
PasswordDisplayNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether password is displayed for a short amount of time as it is being typed for better password control and to prevent mistakes in entering the password.
ExpAckPreLoginInfoNoNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether the explicit acknowledgement of pre-login information is enabled.
TestCallNoNoEnum1Possible values:
  • 0 - btFalse
  • 1 - btTrue
Specifies whether the Test a Call should be enabled or not