PasswordMgmtService (Oracle Fusion Middleware Java API Reference for Oracle Identity Manager)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.iam.passwordmgmt.api
Interface PasswordMgmtService

public interface PasswordMgmtService

Provides common password management functionalities like

Create/Update/Delete Password Policies
Get description of the password policies
Validate given passwords against the applicable Password Policy
Get description of the password policy applicable to user/organization

Method Summary
`PasswordPolicyInfo`	`create(PasswordPolicyInfo passwordPolicyInfo)` Create a new Password Policy
`void`	`delete(java.lang.String passwordPolicyName)` Delete the Password Policy
`java.util.Map`	`getApplicableDefaultChallengeQuestions(java.lang.String username, java.lang.Boolean isUserLogin, java.util.Locale locale)` Returns the localized challenge questions that are available in the system based on the passed locale .
`PasswordPolicyInfo`	`getApplicablePasswordPolicy(java.lang.String userId)` Returns the password policy info applicable to the user
`PasswordPolicyInfo`	`getApplicablePasswordPolicy(java.lang.String userId, java.lang.Boolean isUserLogin)` Returns the password policy info applicable to the user
`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(java.lang.String userID, java.lang.String appInstance)` Returns the description of the password policy applicable to the specific account
`PasswordPolicyDescription`	`getApplicablePasswordPolicyDescription(java.lang.String userID, java.lang.String appInstance, java.util.Locale locale)` Returns the description of the password policy applicable to the specific account
`PasswordPolicyDescription`	`getApplicablePasswordPolicyDescription(User user)` Returns the description of the password policy applicable to the user
`PasswordPolicyInfo`	`getApplicablePasswordPolicyForOrg(java.lang.String orgID)` Returns the password policy info applicable to the org
`PasswordPolicyInfo`	`getDetails(java.lang.String passwordPolicyName)` Get the details of specified Password Policy by Name
`PasswordPolicyDescription`	`getPasswordPolicyDescriptionForOrg(java.lang.String orgKey, java.util.Locale locale)` Returns the applicable password policy for the Organization.
`PasswordPolicyDescription`	`getSystemDefaultPolicyDescription(java.util.Locale locale)` Gets the system default policy description
`void`	`resetPassword(java.lang.String userID)` Deprecated. This method is not longer supported. The preferred way to do this is via `UserManager.resetPassword(String,boolean)`
`void`	`resetPassword(java.lang.String userID, java.util.Map controls)` Deprecated. This method is not longer supported. The preferred way to do this is via `UserManager.resetPassword(String,boolean,Map)`
`java.util.List`	`search(SearchCriteria criteria)` Search for the list of policies having a specified search criteria
`java.util.List`	`search(SearchCriteria criteria, java.util.Map controlParams)` Search for the list of policies having a specified search criteria
`void`	`update(PasswordPolicyInfo passwordPolicyInfo)` Update the attributes of the Password Policy specified.
`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, java.lang.String userID, java.util.Locale locale, boolean isUserLogin)` Validates the given password against the applicable Password Policy Used in the 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 default policy, if user.getEntityId() is null Validates the password of a existing user against the applicable policy, if user.getEntityId() is not null
`ValidationResult`	`validatePasswordAgainstPolicy(char[] password, User user, java.lang.String appInstance, java.util.Locale locale)` Validates the password of a new account against the applicable policy
`ValidationResult`	`validatePasswordAgainstPolicyForOrg(java.lang.String orgKey, User user, char[] password, java.util.Locale locale)` Validate Passowrd against applicable Password policy of the org

Method Detail

resetPassword

@Deprecated
void resetPassword(java.lang.String userID)

Deprecated. This method is not longer supported. The preferred way to do this is via UserManager.resetPassword(String,boolean)

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.
See Also:: UserManager.resetPassword(String,boolean)

resetPassword

@Deprecated
void resetPassword(java.lang.String userID,
                              java.util.Map controls)

Deprecated. This method is not longer supported. The preferred way to do this is via UserManager.resetPassword(String,boolean,Map)

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. It takes a Map of control parameters to perform additional operation along with reset pasword.
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.

controls - This Map contains control parameters used for performing additional opreration along with reset password.
Supported Control Parameters:

SentNotification - Boolean flag whether to send notification or not.
SendNotificationTo - Comma separated email address.

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 User Login of the user, should not be null. Password will be validated against this user's applicable password policy; locale - the locale in which validation errors will be translated in case of password validation failure. If locale is null, It will return result in Server's default locale.
Returns:: a ValidationResult containing the result of the validation
Throws:: {@link - UserNotFoundException} if failed to get user details; 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,
                                               java.lang.String userID,
                                               java.util.Locale locale,
                                               boolean isUserLogin)

Validates the given password against the applicable Password Policy
Used in the 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 id of the user whose password is to be changed. The isUserLogin flag will decide where userID contains the user login or the entity ID. Password will be validated against this user's applicable password policy; locale - the locale in which validation errors will be translated in case of password validation failure. If locale is null, It will return result in Server's default locale.; isUserLogin - Set to true if the userID contains user login and false if the userID contains entity ID.
Returns:: a ValidationResult containing the result of the validation
Throws:: {@link - UserNotFoundException} if failed to get user details; 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 default policy, if user.getEntityId() is null Validates the password of a existing user against the applicable policy, if user.getEntityId() is not null

Parameters:: password - the password to be validated; user - the user's attributes information typically requires firstName, lastName and user login. User ID to be set for existing users.; locale - the locale in which validation errors will be translated in case of password validation failure. If locale is null, It will return result in Server's default locale.
Returns:: a ValidationResult object containing the result of the validation.
Throws:: java.lang.NullPointerException - if null password is passed; {@link - UserNotFoundException} if failed to get user details

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; user - the user's attributes information typically requires firstName, lastName and user login; locale - the locale in which validation errors will be translated in case of password validation failure. If locale is null, It will return result in Server's default locale.
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

Parameters:: user, - the user's attributes information typically requires firstName, lastName and user login
Returns:: PasswordPolicyDescription 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 user login of the existing user
Returns:: PasswordPolicyDescription 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 user login of the user; locale - the locale in which password policy description is required. If locale is null, It will return result in Server's default locale.
Returns:: PasswordPolicyDescription the description of the PasswordPolicy

getSystemDefaultPolicyDescription

PasswordPolicyDescription getSystemDefaultPolicyDescription(java.util.Locale locale)

Gets the system default policy description

Parameters:: locale - the locale in which password policy description is required. If locale is null, It will return result in Server's default locale.
Returns:: PasswordPolicyDescription the description of the system wide default PasswordPolicy

create

PasswordPolicyInfo create(PasswordPolicyInfo passwordPolicyInfo)

Create a new Password Policy

Parameters:: passwordPolicyInfo - This VO contains the details of the Password Policy to be created
Returns:: PasswordPolicyInfo The information of the password policy created

getDetails

PasswordPolicyInfo getDetails(java.lang.String passwordPolicyName)

Get the details of specified Password Policy by Name

Parameters:: passwordPolicyName - The unique Name of the required password policy
Returns:: PasswordPolicyInfo The VO containing the details of the recieved policy

update

void update(PasswordPolicyInfo passwordPolicyInfo)

Update the attributes of the Password Policy specified. Ensure to set either name or id of the password policy.

Parameters:: passwordPolicyInfo - This VO contains the details to be updated for the Password Policy

delete

void delete(java.lang.String passwordPolicyName)

Delete the Password Policy

Parameters:: passwordPolicyName - The unique Name of the password policy to be deleted
Throws:: java.lang.Exception

search

java.util.List search(SearchCriteria criteria)

Search for the list of policies having a specified search criteria

Parameters:: criteria - This VO contains the search criteria
Returns:: List<PasswordPolicyInfo> A list of the password policies matching the search criteria

search

java.util.List search(SearchCriteria criteria,
                      java.util.Map controlParams)

Search for the list of policies having a specified search criteria

Parameters:

criteria - This VO contains the search criteria

controlParams - Parameters to configure the search operation. There are four configuration parameters. STARTROW, ENDROW, SORTEDBY and SORTORDER.

The STARTROW and ENDROW parameters indicates which subset of the complete search result is to be fetched.

The SORTEDBY parameter indicates the attribute on which search result is to be sorted. There is no default sorting. Attribute names for PasswordPolicy (given at oracle.iam.passwordmgmt.vo.Constants$Attributes) can be used for this parameter - pwr_name, pwr_key, etc

The SORTORDER search configuration parameter indicates the order of sorting. There are two possible values for this parameter. To sort the result in ascending order use SortOrder.ASCENDING and to sort the result in descending order use SortOrder.DESCENDING. This parameter is operational only when SORTEDBY is set.

Returns:

List<PasswordPolicyInfo> A list of the password policies matching the search criteria

getApplicablePasswordPolicyDescription

PasswordPolicyDescription getApplicablePasswordPolicyDescription(java.lang.String userID,
                                                                 java.lang.String appInstance)
                                                                 throws NoSuchPasswordPolicyException

Returns the description of the password policy applicable to the specific account

Parameters:: userID - the User Login of the user who is getting provision for this account, should not be null.; appInstance - name the application instance name to be provisioned
Returns:: the description of the PasswordPolicy
Throws:: NoSuchPasswordPolicyException - if failed to get appInstance details.

getApplicablePasswordPolicyDescription

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

Returns the description of the password policy applicable to the specific account

Parameters:: userID - the User Login of the user who is getting provision for this account, should not be null.; appInstance - name the application instance name to be provisioned; locale - the locale in which password policy description is required. If locale is null, It will return result in Server's default locale.
Returns:: the description of the PasswordPolicy
Throws:: NoSuchPasswordPolicyException - if failed to get appInstance details.

validatePasswordAgainstPolicy

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

Validates the password of a new account against the applicable policy

Parameters:: password - the password to be validated; user - the user's attributes information; appInstance - name the application instance name to be provisioned; locale - the locale in which validation errors will be translated in case of password validation failure. If locale is null, It will return result in Server's default locale.
Returns:: a ValidationResult object containing the result of the validation.
Throws:: java.lang.NullPointerException - if null password is passed

getPasswordPolicyDescriptionForOrg

PasswordPolicyDescription getPasswordPolicyDescriptionForOrg(java.lang.String orgKey,
                                                             java.util.Locale locale)

Returns the applicable password policy for the Organization.

Parameters:: orgKey - - the key of the organization; locale - - the locale in which password policy description is required. If locale is null, It will return result in Server's default locale.
Returns:: PasswordPolicyDescription the description of PasswordPolicy attached to org

validatePasswordAgainstPolicyForOrg

ValidationResult validatePasswordAgainstPolicyForOrg(java.lang.String orgKey,
                                                     User user,
                                                     char[] password,
                                                     java.util.Locale locale)

Validate Passowrd against applicable Password policy of the org

Parameters:: orgKey - - the key of the organization; user - - the user for which password is to be validated; password - - the password to be validated; locale - - the locale in which validation result is required. If locale is null, It will return result in Server's default locale.
Returns:: a ValidationResult object containing the result of the validation.

getApplicablePasswordPolicy

PasswordPolicyInfo getApplicablePasswordPolicy(java.lang.String userId)

Returns the password policy info applicable to the user

Parameters:: userId - the user login of the existing user. If user login is null, default system password policy is returned. userId is treated as user-login. To fetch the applicable password policy for a given id(user-key) please use
Returns:: PasswordPolicyInfo the PasswordPolicyInfo applicable to the user
See Also:: PasswordMgmtService.getApplicablePasswordPolicy(String, Boolean)

getApplicablePasswordPolicy

PasswordPolicyInfo getApplicablePasswordPolicy(java.lang.String userId,
                                               java.lang.Boolean isUserLogin)

Returns the password policy info applicable to the user

Parameters:: userId - the userID of the existing user. If userId is null, default system password policy is returned.; isUserLogin - the flag decides whether userID contains the user login(if true) or the entity ID (if false).
Returns:: PasswordPolicyInfo the PasswordPolicyInfo applicable to the user
See Also:: PasswordMgmtService.getApplicablePasswordPolicy(String, Boolean)

getApplicablePasswordPolicyForOrg

PasswordPolicyInfo getApplicablePasswordPolicyForOrg(java.lang.String orgID)

Returns the password policy info applicable to the org

Parameters:: orgID - the organization id for which password policy needs to be returned
Returns:: PasswordPolicyInfo the PasswordPolicyInfo applicable to the org

getApplicableDefaultChallengeQuestions

java.util.Map getApplicableDefaultChallengeQuestions(java.lang.String username,
                                                     java.lang.Boolean isUserLogin,
                                                     java.util.Locale locale)

Returns the localized challenge questions that are available in the system based on the passed locale .

Parameters:: userId - the userID of the existing user; isUserLogin - the flag decides whether userID contains the user login(if true) or the entity ID (if false).; locale - the locale in which challenge questions are required.
Returns:: A map of String keys (representing Challenge Questions in english) and String values (representing localized challenge questions) returns empty map if challenge policy is disabled

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.iam.passwordmgmt.api Interface PasswordMgmtService

resetPassword

resetPassword

validatePasswordAgainstPolicy

validatePasswordAgainstPolicy

validatePasswordAgainstPolicy

validatePasswordAgainstDefaultPolicy

getApplicablePasswordPolicyDescription

getApplicablePasswordPolicyDescription

getApplicablePasswordPolicyDescription

getSystemDefaultPolicyDescription

create

getDetails

update

delete

search

search

getApplicablePasswordPolicyDescription

getApplicablePasswordPolicyDescription

validatePasswordAgainstPolicy

getPasswordPolicyDescriptionForOrg

validatePasswordAgainstPolicyForOrg

getApplicablePasswordPolicy

getApplicablePasswordPolicy

getApplicablePasswordPolicyForOrg

getApplicableDefaultChallengeQuestions

oracle.iam.passwordmgmt.api
Interface PasswordMgmtService