|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.util.List |
getAllowedBackURLs() Returns allowed backURLs that are allowed in OIM. |
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. |
java.util.Map |
getSystemChallengeQuestions(java.util.Locale locale) Returns the localized challenge questions that are available in the system based on the passed locale . |
void |
notifyForgottenUsername(java.lang.String email, java.util.Map optionsMap) Notifies the user about the username at the email address provided. |
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. |
void |
setChallengeValues(java.lang.String userLogin, char[] password, java.util.Map challengeParams) Set challenge questions and answers for unauthenticated user |
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. |
boolean |
validateSelfRegistrationEmail(java.lang.String email, java.util.Map optionsMap) Validates whether the self registering user can register with the email address provided. |
Method Detail |
---|
java.lang.String[] getChallengeQuestions(java.lang.String userName) throws AuthSelfServiceException, UserAccountDisabledException, UserAccountInvalidException
userName
- The user login id in the system.AuthSelfServiceException
UserAccountDisabledException
UserAccountInvalidException
boolean resetPassword(java.lang.String userName, java.util.Map quesAns, char[] passwd) throws AuthSelfServiceException, UserAccountDisabledException, UserAccountInvalidException, NumberOfChallengesMismatchException, QuestionsNotDefinedException, PasswordIncorrectException, PasswordMismatchException, PasswordPolicyException, PasswordResetAttemptsExceededException, UserAlreadyLoggedInException
userName
- The user login in the system.quesAns
- The map containing questions and answers answered by user.passwd
- New passwordAuthSelfServiceException
UserAccountDisabledException
UserAccountInvalidException
NumberOfChallengesMismatchException
QuestionsNotDefinedException
PasswordIncorrectException
PasswordMismatchException
PasswordPolicyException
PasswordResetAttemptsExceededException
UserAlreadyLoggedInException
java.lang.String[] getSystemChallengeQuestions() throws AuthSelfServiceException, InvalidLookupException
AuthSelfServiceException
InvalidLookupException
java.util.Map getSystemChallengeQuestions(java.util.Locale locale) throws AuthSelfServiceException, InvalidLookupException
AuthSelfServiceException
InvalidLookupException
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
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.xmlRequestServiceException
InvalidRequestException
InvalidRequestDataException
BulkBeneficiariesAddException
BulkEntitiesAddException
oracle.iam.platform.kernel.ValidationFailedException
UnauthenticatedSelfServiceException
void setChallengeValues(java.lang.String userLogin, char[] password, java.util.Map challengeParams) throws UnauthenticatedSelfServiceException, UserAccountDisabledException, UserAccountInvalidException, NumberOfChallengesMismatchException, InvalidQuestionException
userLogin
- User Loginpassword
- User passwordchallengeParams
- Challenge questions and answers mapUnauthenticatedSelfServiceException
UserAccountInvalidException
UserAccountDisabledException
NumberOfChallengesMismatchException
InvalidQuestionException
boolean validateSelfRegistrationEmail(java.lang.String email, java.util.Map optionsMap)
email
- The email address of the self registering user.optionsMap
- Further context information.void notifyForgottenUsername(java.lang.String email, java.util.Map optionsMap) throws UnauthenticatedSelfServiceException, NotificationException
email
- The email address of the user.optionsMap
- Further context information.UnauthenticatedSelfServiceException
- in case there is no match.NotificationException
- if there is an error while sending the email.java.util.List getAllowedBackURLs()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |