Skip navigation links

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.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

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

getSystemChallengeQuestions

java.util.Map getSystemChallengeQuestions(java.util.Locale locale)
                                          throws AuthSelfServiceException,
                                                 InvalidLookupException

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

Returns:

A map of String keys (representing Challenge Questions in english) and String values (representing localized challenge questions)

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

setChallengeValues

void setChallengeValues(java.lang.String userLogin,
                        char[] password,
                        java.util.Map challengeParams)
                        throws UnauthenticatedSelfServiceException,
                               UserAccountDisabledException,
                               UserAccountInvalidException,
                               NumberOfChallengesMismatchException,
                               InvalidQuestionException

Set challenge questions and answers for unauthenticated user

Parameters:

userLogin - User Login

password - User password

challengeParams - Challenge questions and answers map

Throws:

UnauthenticatedSelfServiceException

UserAccountInvalidException

UserAccountDisabledException

NumberOfChallengesMismatchException

InvalidQuestionException

validateSelfRegistrationEmail

boolean validateSelfRegistrationEmail(java.lang.String email,
                                      java.util.Map optionsMap)

Validates whether the self registering user can register with the email address provided. Email argument is mandatory and cannot be passed as null. Multiple usernames are allowed in case of MT-friendly OIM even for the same email and tenant name combination.

Parameters:

email - The email address of the self registering user.

optionsMap - Further context information.

Returns:

true in case there is no match.

notifyForgottenUsername

void notifyForgottenUsername(java.lang.String email,
                             java.util.Map optionsMap)
                             throws UnauthenticatedSelfServiceException,
                                    NotificationException

Notifies the user about the username at the email address provided. Email argument is mandatory and cannot be passed as null. In case of MT-friendly OIM (i.e. OIM PaaS Edition), the optionsMap must contain an entry with either the key UserManagerConstants.AttributeName.TENANT_NAME and the tenant name string value or the key UserManagerConstants.AttributeName.TENANT_ID and the tenant GUID string value. Multiple usernames may be found in case of MT-friendly OIM and they will all be included in the sent email content.

Parameters:

email - The email address of the user.

optionsMap - Further context information.

Throws:

UnauthenticatedSelfServiceException - in case there is no match.

NotificationException - if there is an error while sending the email.

getAllowedBackURLs

java.util.List getAllowedBackURLs()

Returns allowed backURLs that are allowed in OIM.

Returns:

List of allowed back urls, Read from the OIM configuration files and system-property as XL.AllowedBackURLs for the customizations.

Skip navigation links