UnauthenticatedSelfService (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.selfservice.uself.uselfmgmt.api
Interface UnauthenticatedSelfService

public interface UnauthenticatedSelfService

The UnauthenticatedSelfService API exposes the methods to a user who is not logged-in to the system to submit a request to register himself in the system and reset his forgotten/expired password.

Method Summary
`java.lang.String[]`	`getChallengeQuestions(java.lang.String userName)` Accepts the user login id and returns the set of challenge questions set by the user.
`java.lang.String[]`	`getSystemChallengeQuestions()` Returns the challenge questions that are available in the system.
`boolean`	`resetPassword(java.lang.String userName, java.util.Map quesAns, char[] passwd)` Accepts user login id, map of questions and answers and the new password and returns boolean flag depending on reset password success or failure.
`java.lang.String`	`submitRegistrationRequest(java.util.Map requestDataMap, java.util.Map quesAndAnsMap, java.lang.String templateName, java.util.Map datasetAttributes)` Accepts the user registration data,the questions and answers set by user, request template name and the dataset.

Method Detail

getChallengeQuestions

java.lang.String[] getChallengeQuestions(java.lang.String userName)
                                         throws AuthSelfServiceException,
                                                UserAccountDisabledException,
                                                UserAccountInvalidException

Accepts the user login id and returns the set of challenge questions set by the user.

Parameters:: userName - The user login id in the system.
Returns:: array of Strings containing the challenge questions defined by the user.
Throws:: AuthSelfServiceException; UserAccountDisabledException; UserAccountInvalidException

resetPassword

boolean resetPassword(java.lang.String userName,
                      java.util.Map quesAns,
                      char[] passwd)
                      throws AuthSelfServiceException,
                             UserAccountDisabledException,
                             UserAccountInvalidException,
                             NumberOfChallengesMismatchException,
                             QuestionsNotDefinedException,
                             PasswordIncorrectException,
                             PasswordMismatchException,
                             PasswordPolicyException,
                             PasswordResetAttemptsExceededException,
                             UserAlreadyLoggedInException

Accepts user login id, map of questions and answers and the new password and returns boolean flag depending on reset password success or failure.

Parameters:: userName - The user login in the system.; quesAns - The map containing questions and answers answered by user.; passwd - New password
Returns:: boolean value depending on the reset status.'true' indicates password is reset successfully.
Throws:: AuthSelfServiceException; UserAccountDisabledException; UserAccountInvalidException; NumberOfChallengesMismatchException; QuestionsNotDefinedException; PasswordIncorrectException; PasswordMismatchException; PasswordPolicyException; PasswordResetAttemptsExceededException; UserAlreadyLoggedInException

getSystemChallengeQuestions

java.lang.String[] getSystemChallengeQuestions()
                                               throws AuthSelfServiceException,
                                                      InvalidLookupException

Returns the challenge questions that are available in the system.

Returns:: An array of Strings containing challenge questions defined in system.
Throws:: AuthSelfServiceException; InvalidLookupException

submitRegistrationRequest

java.lang.String submitRegistrationRequest(java.util.Map requestDataMap,
                                           java.util.Map quesAndAnsMap,
                                           java.lang.String templateName,
                                           java.util.Map datasetAttributes)
                                           throws RequestServiceException,
                                                  InvalidRequestException,
                                                  InvalidRequestDataException,
                                                  BulkBeneficiariesAddException,
                                                  BulkEntitiesAddException,
                                                  oracle.iam.platform.kernel.ValidationFailedException,
                                                  UnauthenticatedSelfServiceException

Accepts the user registration data,the questions and answers set by user, request template name and the dataset. Returns request ID.

Parameters:: requestDataMap - Map containing details for user registration.; quesAndAnsMap - Map containing challenge questions and answers defined by user while registration.; templateName - template used for registration.; datasetAttributes - Map containing attributes and corresponding attribute references as defined in request dataset template CreateUserDataSet.xml
Returns:: request ID
Throws:: RequestServiceException; InvalidRequestException; InvalidRequestDataException; BulkBeneficiariesAddException; BulkEntitiesAddException; oracle.iam.platform.kernel.ValidationFailedException; UnauthenticatedSelfServiceException