Getting the password policy

Execution permission

You must be a system administrator or a security administrator.

Request line

GET base-URL/security/v1/password-policy

Request message

Object ID

None.

Query parameters

None.

Body

None.

Response message

Body

{
    "length": 8,
    "upperCase": 1,
    "lowerCase": 1,
    "digits": 1,
    "specialChars": 1,
    "bruteForceProtected": true,
    "failureFactor": 5
}

Attribute	Type	Description
length	int	Minimum number of characters required for a password
upperCase	int	Minimum number of uppercase characters required in a password
lowerCase	int	Minimum number of lowercase characters required in a password
digits	int	Minimum number of numeric characters required in a password
specialChars	int	Minimum number of symbols required in a password
bruteForceProtected	boolean	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	Number of unsuccessful login attempts allowed before a user account is locked

Coding example

curl -v -X GET -s "https://example.com:443/portal/security/v1/password-policy" -H "Authorization:Bearer eyJhbxxx"