|
|||||||||
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.
Below is the code snippet that shows how to get an instance of this service:
//returns an UnauthenticatedSelfService service instance
Hashtable<String, String> env = new Hashtable<String, String>();
env.put(OIMClient.JAVA_NAMING_PROVIDER_URL, "t3://oimhost:oimport";
env.put(OIMClient.JAVA_NAMING_FACTORY_INITIAL, "weblogic.jndi.WLInitialContextFactory");
env.put("APPSERVER_TYPE", "wls");
OIMClient client = new OIMClient(env);
UnauthenticatedSelfService unauthSelfSvc = client.getService(UnauthenticatedSelfService.class);
// Gets the list of challenge questions for the username provided as an argument of the method.
String[] challengeQuestions = unauthSelfSvc.getChallengeQuestions(userName)();
....
Method Summary | |
---|---|
boolean |
canSelfRecoverPassword(java.lang.String username) Find out if the user is eligible to recover the password using challenges. |
java.util.List |
getAllowedBackURLRequestParams() Returns list of HTTP Request Parameters that OIM will validate for redirection |
java.util.List |
getAllowedBackURLs() Returns allowed backURLs that are allowed in OIM. |
java.lang.String |
getAllowedBackURLsMode() Returns Allowed Back Url Mode set 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.util.Map |
getChallengeQuestions(java.lang.String userName, java.util.Locale locale) Accepts the user login id and returns the set of challenge questions set by the user in given locale. |
java.util.Map |
getSecureURLProperties() Returns Map of All the Secure URL related System properties This map will have: - XL.AllowedBackURLsMode - URL Mode (String) - XL.AllowedBackURLs - List of URLs (List) - XL.AllowedBackURLsRequestParameters - List of URL request params (List) |
java.lang.String[] |
getSystemChallengeQuestions() Deprecated. This method is not longer supported. The preferred way to do this is via PasswordMgmtService.getApplicableDefaultChallengeQuestions(String,Boolean,Locale) |
java.util.Map |
getSystemChallengeQuestions(java.util.Locale locale) Deprecated. This method is not longer supported. The preferred way to do this is via PasswordMgmtService.getApplicableDefaultChallengeQuestions(String,Boolean,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) Deprecated. This method is not longer supported. The preferred way to do this is via AuthenticatedSelfService.setChallengeValues(Map) |
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
java.util.Map getChallengeQuestions(java.lang.String userName, java.util.Locale locale) throws AuthSelfServiceException, UserAccountDisabledException, UserAccountInvalidException
userName
- The user login id in the system.locale
- Locale in which challenges needs to be returnedAuthSelfServiceException
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
@Deprecated
java.lang.String[] getSystemChallengeQuestions()
throws AuthSelfServiceException,
InvalidLookupException
PasswordMgmtService.getApplicableDefaultChallengeQuestions(String,Boolean,Locale)
AuthSelfServiceException
InvalidLookupException
@Deprecated
java.util.Map getSystemChallengeQuestions(java.util.Locale locale)
throws AuthSelfServiceException,
InvalidLookupException
PasswordMgmtService.getApplicableDefaultChallengeQuestions(String,Boolean,Locale)
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
@Deprecated
void setChallengeValues(java.lang.String userLogin,
char[] password,
java.util.Map challengeParams)
throws UnauthenticatedSelfServiceException,
UserAccountDisabledException,
UserAccountInvalidException,
NumberOfChallengesMismatchException,
InvalidQuestionException
AuthenticatedSelfService.setChallengeValues(Map)
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.boolean canSelfRecoverPassword(java.lang.String username) throws UserAccountDisabledException, UserAccountInvalidException, ResetPasswordException, PasswordPolicyException, QuestionsNotDefinedException, AuthSelfServiceException
username
- Username of the userUserAccountDisabledException
UserAccountInvalidException
ResetPasswordException
PasswordPolicyException
QuestionsNotDefinedException
AuthSelfServiceException
java.util.List getAllowedBackURLs()
java.lang.String getAllowedBackURLsMode()
java.util.List getAllowedBackURLRequestParams()
java.util.Map getSecureURLProperties()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |