Skip to navigation

Update password rules

View as Markdown

Authentication

Authorizationstring

OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer <token>.

Path parameters

accountIdstringRequired

The external account number (int) or account id GUID.

Request

This endpoint expects an object: accountPasswordRules

expirePasswordstringOptional
expirePasswordDaysstringOptional
expirePasswordDaysMetadataobjectOptional
lockoutDurationMinutesstringOptional
lockoutDurationMinutesMetadataobjectOptional
lockoutDurationTypestringOptional
lockoutDurationTypeMetadataobjectOptional
minimumPasswordAgeDaysstringOptional
minimumPasswordAgeDaysMetadataobjectOptional
minimumPasswordLengthstringOptional
minimumPasswordLengthMetadataobjectOptional
passwordIncludeDigitstringOptional
passwordIncludeDigitOrSpecialCharacterstringOptional
passwordIncludeLowerCasestringOptional
passwordIncludeSpecialCharacterstringOptional
passwordIncludeUpperCasestringOptional
passwordStrengthTypestringOptional
passwordStrengthTypeMetadataobjectOptional
questionsRequiredstringOptional
questionsRequiredMetadataobjectOptional

Information about the number of password questions required (0 to 4) to confirm a user’s identity when a user needs to reset their password.

Response

Successful response.
expirePasswordstringOptional
expirePasswordDaysstringOptional
expirePasswordDaysMetadataobjectOptional
lockoutDurationMinutesstringOptional
lockoutDurationMinutesMetadataobjectOptional
lockoutDurationTypestringOptional
lockoutDurationTypeMetadataobjectOptional
minimumPasswordAgeDaysstringOptional
minimumPasswordAgeDaysMetadataobjectOptional
minimumPasswordLengthstringOptional
minimumPasswordLengthMetadataobjectOptional
passwordIncludeDigitstringOptional
passwordIncludeDigitOrSpecialCharacterstringOptional
passwordIncludeLowerCasestringOptional
passwordIncludeSpecialCharacterstringOptional
passwordIncludeUpperCasestringOptional
passwordStrengthTypestringOptional
passwordStrengthTypeMetadataobjectOptional
questionsRequiredstringOptional
questionsRequiredMetadataobjectOptional

Information about the number of password questions required (0 to 4) to confirm a user’s identity when a user needs to reset their password.

Errors

400
Bad Request Error