Password Policy Config
  • 16 Jun 2022
  • 2 Minutes to read
  • Dark
    Light

Password Policy Config

  • Dark
    Light

Article Summary

Password Policy Config

Password Policy Config JSON Format

Password Policy Config is represented as simple flat JSON objects with the following keys:

NameTypeDescription
isMinimumPasswordLengthEnabledboolWhether the Minimum Password Length is enabled or not.
isReusePreviousPasswordsPreventedboolWhether the Reuse Previous Passwords Prevented is enabled or not.
isPasswordExpiredInCertainDaysboolWhether the Password Expired In Certain Days is enabled or not.
isPasswordComplexityRequiredboolWhether the Password Complexity Required is enabled or not.
isPasswordContainingUsernamePreventedboolWhether the Password Containing Username Prevented is enabled or not.
isDailyPasswordChangeTimesLimitedboolWhether the Daily Password Change Times Limited is enabled or not.
isSimplePasswordPreventedboolWhether simple and commonly used passwords are restricted or not.
isAgentLockedAfterCertainAttemptsboolWhether the Agent Locked After Certain Attempts is enabled or not.
siteIdintegerId of the site.
minimumPasswordLengthintegerMinimum length of the password.
previousPasswordsRememberedintegerNumber of the last passwords that can not be used this time.
maximumDailyPasswordChangeTimesintegerMaximum number of password changes allowed daily.
maximumLoginAttemptsBeforeLockintegerMaximum number of login attempts allowed before the account is locked.
passwordExpiredInCertainDaysintegerNumber of days the password is valid for.

Get a single Password Policy Config

GET global/passwordPolicyConfig

  • Parameters:

No Parameters

  • Response:

Password Policy Config

  • Example

Sample Request:

curl https://api11.comm100.io/v4/global/passwordPolicyConfig \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 200 OK

{
  "isMinimumPasswordLengthEnabled": false,
  "isReusePreviousPasswordsPrevented": false,
  "isPasswordExpiredInCertainDays": false,
  "isPasswordComplexityRequired": false,
  "isPasswordContainingUsernamePrevented": false,
  "isDailyPasswordChangeTimesLimited": false,
  "isSimplePasswordPrevented": false,
  "isAgentLockedAfterCertainAttempts": false,
  "siteId": 10000,
  "minimumPasswordLength": 6,
  "previousPasswordsRemembered": 1,
  "maximumDailyPasswordChangeTimes": 2,
  "maximumLoginAttemptsBeforeLock": 6,
  "passwordExpiredInCertainDays": 1
} 

Update the Password Policy Config

PUT global/passwordPolicyConfig

  • Parameters:

NameTypeinRequiredDescription
isMinimumPasswordLengthEnabledboolbodynoWhether the Minimum Password Length is enabled or not.
isReusePreviousPasswordsPreventedboolbodynoWhether the Reuse Previous Passwords Prevented is enabled or not.
isPasswordExpiredInCertainDaysboolbodynoWhether the Password Expired In Certain Days is enabled or not.
isPasswordComplexityRequiredboolbodynoWhether the Password Complexity Required is enabled or not.
isPasswordContainingUsernamePreventedboolbodynoWhether the Password Containing Username Prevented is enabled or not.
isDailyPasswordChangeTimesLimitedboolbodynoWhether the Daily Password Change Times Limited is enabled or not.
isSimplePasswordPreventedboolbodynoWhether simple and commonly used passwords are restricted or not.
isAgentLockedAfterCertainAttemptsboolbodynoWhether the Agent Locked After Certain Attempts is enabled or not.
minimumPasswordLengthintegerbodynoMinimum length of the password.
previousPasswordsRememberedintegerbodynoNumber of the last passwords that can not be used this time.
maximumDailyPasswordChangeTimesintegerbodynoMaximum number of password changes allowed daily.
maximumLoginAttemptsBeforeLockintegerbodynoMaximum number of login attempts allowed before the account is locked.
passwordExpiredInCertainDaysintegerbodynoNumber of days the password is valid for.
  • Response:

Password Policy Config

  • Example

Sample Request:

curl https://api11.comm100.io/v4/global/passwordPolicyConfig \ 
    -X 'PUT' \ 
    -H 'Authorization: Bearer {access_token}' \ 
    -H 'Content-Type: application/json' \ 
    -D '{"isMinimumPasswordLengthEnabled":false,"isReusePreviousPasswordsPrevented":false,"isPasswordExpiredInCertainDays":false,"isPasswordComplexityRequired":false,"isPasswordContainingUsernamePrevented":false,"isDailyPasswordChangeTimesLimited":false,"isSimplePasswordPrevented":false,"isAgentLockedAfterCertainAttempts":false,"minimumPasswordLength":6,"previousPasswordsRemembered":1,"maximumDailyPasswordChangeTimes":2,"maximumLoginAttemptsBeforeLock":6,"passwordExpiredInCertainDays":1}' 

Response:

HTTP/1.1 200 OK

{
  "isMinimumPasswordLengthEnabled": false,
  "isReusePreviousPasswordsPrevented": false,
  "isPasswordExpiredInCertainDays": false,
  "isPasswordComplexityRequired": false,
  "isPasswordContainingUsernamePrevented": false,
  "isDailyPasswordChangeTimesLimited": false,
  "isSimplePasswordPrevented": false,
  "isAgentLockedAfterCertainAttempts": false,
  "siteId": 10000,
  "minimumPasswordLength": 6,
  "previousPasswordsRemembered": 1,
  "maximumDailyPasswordChangeTimes": 2,
  "maximumLoginAttemptsBeforeLock": 6,
  "passwordExpiredInCertainDays": 1
} 

Was this article helpful?

What's Next