Execution permission
You must be a system administrator or a security administrator.
Request line
PUT base-URL/security/v1/password-policy
Request message
- Object ID
- None.
- Query parameters
- None.
- Body
-
{ "length": 8, "upperCase": 1, "lowerCase": 1, "digits": 1, "specialChars": 1, "bruteForceProtected": true, "failureFactor": 5 }
Attribute
Type
Description
length
int
(Required) Minimum number of characters required for a password
Specify a value in the range from 1 to 256.
upperCase
int
(Required) Minimum number of uppercase characters required in a password
Specify a value in the range from 0 to 256. If you do not want to set a minimum for the number of uppercase characters, specify 0.
lowerCase
int
(Required) Minimum number of lowercase characters required in a password
Specify a value in the range from 0 to 256. If you do not want to set a minimum for the number of lowercase characters, specify 0.
digits
int
(Required) Minimum number of numeric characters required in a password
Specify a value in the range from 0 to 256. If you do not want to set a minimum for the number of numeric characters, specify 0.
specialChars
int
(Required) Minimum number of symbols required in a password
Specify a value in the range from 0 to 256. If you do not want to set a minimum for the number of symbols, specify 0.
bruteForceProtected
boolean
(Required) Whether to lock a user account after a certain number of unsuccessful login attempts
- true: Locks the account.
- false: Does not lock the account.
failureFactor
int
(Optional) Number of unsuccessful login attempts allowed before a user account is locked
Specify a value in the range from 1 to 256. If you specified true for the bruteForceProtected attribute, you must specify this attribute.
Coding example
curl -v -X PUT -H "Content-Type:application/json" -s "https://example.com:443/portal/security/v1/password-policy" -d @./request.json -H "Authorization:Bearer eyJhbxxx"