Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
borderColor#000000
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#000000
borderWidthborderStyle1solid
titleIntroduction
borderStylesolid

The Forgot Username function is for end-users to retrieve forgotten usernames by clicking the Forgot Username link during the login process.

This resource can be applied to any SecureAuth IdP realmUse this guide to configure the Forgot Username page, where end-users can retrieve forgotten user IDs.

The Forgot Username tool enables an end-user to provide information associated with their directory account in order to reacquire their username to log into SecureAuth IdP realms.

Each SecureAuth IdP realm can include a Forgot Username URL Link (Overview tab) that displays on the initial login page. Clicking the link redirects end-users to the Forgot Username realm, at which the end-user enters information from a defined field (e.g. email address, phone number, etc.) to confirm the account identity.

Upon successful identity validation, the username is displayed on the page itself or sent to the user via email, as configured by the administrator.

Panel
borderColor#444443
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#444443
borderWidthborderStyle1solid
titlePrerequisites
borderStylesolid

1. Create a New Realm for the Forgot Username function

2. Configure the following tabs in the Web Admin before configuring the Post Authentication tab:

  • Overview – the description of the realm and SMTP connections must be defined
  • Data – an enterprise directory must be integrated with SecureAuth IdP
  • Workflow – the way in which users will access this application must be defined
  • Registration Methods – the 2-Factor Authentication methods that will be used to access this page (if any) must be defined
Panel
borderColor#135570
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#135570
borderWidthborderStyle1solid
titleConfiguration Steps
borderStylesolid
Panel
borderColor#116490
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#116490
borderWidthborderStyle1solid
titleData
borderStylesolid
Info

This is a configuration example using an Active Directory integration and common data fields, so it is not universal for every enterprise data store

Section
Column
width50%

1. In the Membership Connection Settings section, change the searchFilter to accept the user's email address on the initial login page (instead of the username)

This would correspond to the field in the enterprise directory that contains the email address, e.g. (&(mail=%v)(objectclass=*))

Column

2. The value in the Search Attribute must be sent in a token, so assign the data store field to a SecureAuth IdP Profile Field

For example: The Search Attribute sAMAccountName is now assigned to Aux ID 1 in the Profile Fields section

Warning

Click Save once the configurations have been completed and before leaving the Data page to avoid losing changes

Panel
borderColor#116490
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#116490
borderWidthborderStyle1solid
titleWorkflow
borderStylesolid
Section
Column
width50%

Column

 

3. In the Custom Front End section, select the appropriate Profile Field from the Token Data Type (Send) dropdown

Using the same example, select Aux ID 1

Warning

Click Save once the configurations have been completed and before leaving the Workflow page to avoid losing changes

Panel
borderColor#116490
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#116490
borderWidthborderStyle1solid
titlePost Authentication
borderStylesolid
Section
Column
width50%

Column

 

4. Select Forgot Username from the Authenticated User Redirect dropdown in the Post Authentication tab in the Web Admin

5. An unalterable URL will be auto-populated in the Redirect To field, which will append to the domain name and realm number in the address bar (Authorized/ForgotUsername.aspx)

6. A customized post authentication page can be uploaded, but it is not required

Panel
borderColor#007fb2
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#007fb2
borderWidthborderStyle1solid
titleUser ID Mapping
borderStylesolid
Section
Column
width50%

Column

 

7. Select the type of User ID that will be asserted to the Forgot Username page from the User ID Mapping dropdown

This is typically the Authenticated User ID

Panel
borderColor#007fb2
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#007fb2
borderWidthborderStyle1solid
titleForgot Username
borderStylesolid
Section
Column
width50%

Column

 

8. Choose the Username Delivery Option, which will either be to Display on page or to Send in email to the field designated in the searchFilter

Warning

Click Save once the configurations have been completed and before leaving the Post Authentication page to avoid losing changes

Panel
borderColor#007fb2
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#007fb2
borderWidthborderStyle1solid
titleForms Auth / SSO Token
borderStylesolid
Section
Column
width50%

Column

 

9. Click View and Configure FormsAuth keys / SSO token to configure the token/cookie settings and to configure this realm for Single Sign-on (SSO)

Info

These are optional configurations

Excerpt Include
Account Management (Help Desk) Page Configuration Guide
Account Management (Help Desk) Page Configuration Guide
nopaneltrue

Panel
borderColor#116490
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#116490
borderWidthborderStyle1solid
titleOverview
borderStylesolid
Section
Column
width50%

Column

 

10. In the Page Content section, update the Forgot Username URL field and its Location on the login page within the other SecureAuth IdP realms in which the function is available

The URL would be: /SecureAuth[ForgotUsernameRealm#]

Warning

Click Save once the configurations have been completed and before leaving the Overview page to avoid losing changes