Skip navigation links

oracle.iam.passwordmgmt.api
Interface PasswordMgmtService

public interface PasswordMgmtService

Provides common password management functionalities like

• Validate given passwords against the applicable Password Policy
• Reset the password of an user

Method Summary

PasswordPolicyDescription	getApplicablePasswordPolicyDescription(java.lang.String userID) Returns the description of the password policy applicable to the user
PasswordPolicyDescription	getApplicablePasswordPolicyDescription(java.lang.String userID, java.util.Locale locale) Returns the description of the password policy applicable to the user.
PasswordPolicyDescription	getApplicablePasswordPolicyDescription(User user) Returns the description of the password policy applicable to the user in case of create user
void	resetPassword(java.lang.String userID) Resets the password of an user to a randomly generated password.
ValidationResult	validatePasswordAgainstDefaultPolicy(char[] password, User user, java.util.Locale locale) Validates the password of a new user against the default policy Used in following scenarios Self Registration Creation of user by Delegated Admin
ValidationResult	validatePasswordAgainstPolicy(char[] password, java.lang.String userID, java.util.Locale locale) Validates the given password against the applicable Password Policy Used in following scenarios Validating the password entered by the user while changing his/her password Validating the password entered by a delegated admin while changing the password of the user
ValidationResult	validatePasswordAgainstPolicy(char[] password, User user, java.util.Locale locale) Validates the password of a new user against the applicable policy Used in following scenarios Self Registration Creation of user by Delegated Admin

Method Detail

resetPassword

void resetPassword(java.lang.String userID)

Resets the password of an user to a randomly generated password. As part of the password reset, a notification is sent to the user regarding the new password
NOTE: The email attribute of the user must be set for reset password to work

Parameters:

userID - the userID of the user whose password is to be reset.

validatePasswordAgainstPolicy

ValidationResult validatePasswordAgainstPolicy(char[] password,
                                               java.lang.String userID,
                                               java.util.Locale locale)

Validates the given password against the applicable Password Policy
Used in following scenarios

• Validating the password entered by the user while changing his/her password
• Validating the password entered by a delegated admin while changing the password of the user

Parameters:

password - the password to be validated, should not be null

userID - the userID of the user, should not be null

locale - the locale in which validation errors will be translated in case of password validation failure

Returns:

a ValidationResult containing the result of the validation

Throws:

java.lang.NullPointerException - if null userID or password is passed This object contains the validation status (success/failure) and the validation errors, if any

validatePasswordAgainstPolicy

ValidationResult validatePasswordAgainstPolicy(char[] password,
                                               User user,
                                               java.util.Locale locale)

Validates the password of a new user against the applicable policy
Used in following scenarios

• Self Registration
• Creation of user by Delegated Admin

Parameters:

password - the password to be validated

userInfo - the user's attributes information. Password validation typically requires firstName, lastName and userID

locale - the locale in which validation errors will be translated in case of password validation failure

Returns:

a ValidationResult object containing the result of the validation.

Throws:

java.lang.NullPointerException - if null password is passed

validatePasswordAgainstDefaultPolicy

ValidationResult validatePasswordAgainstDefaultPolicy(char[] password,
                                                      User user,
                                                      java.util.Locale locale)

Validates the password of a new user against the default policy
Used in following scenarios

• Self Registration
• Creation of user by Delegated Admin

Parameters:

password - the password to be validated

userInfo - the user's attributes information. Password validation typically requires firstName, lastName and userID

locale - the locale in which validation errors will be translated in case of password validation failure

Returns:

a ValidationResult object containing the result of the validation.

Throws:

java.lang.NullPointerException - if null password is passed

getApplicablePasswordPolicyDescription

PasswordPolicyDescription getApplicablePasswordPolicyDescription(User user)

Returns the description of the password policy applicable to the user in case of create user

Parameters:

userInfo, - UserInfo object

Returns:

the description of the PasswordPolicy

getApplicablePasswordPolicyDescription

PasswordPolicyDescription getApplicablePasswordPolicyDescription(java.lang.String userID)

Returns the description of the password policy applicable to the user

Parameters:

userID - the userID of the existing user

Returns:

the description of the PasswordPolicy

getApplicablePasswordPolicyDescription

PasswordPolicyDescription getApplicablePasswordPolicyDescription(java.lang.String userID,
                                                                 java.util.Locale locale)

Returns the description of the password policy applicable to the user.

Parameters:

userID - the userID of the user

locale - the locale in which password policy description is required.

Returns:

the description of the PasswordPolicy

Skip navigation links