Select the type of directory integration used for the Forgot Username realm and follow the appropriate steps
UI Tabs
UI Tab
title
LDAP Directories (AD and others)
Panel
borderColor
#126591
bgColor
white
titleColor
white
borderWidth
1
titleBGColor
#126591
borderStyle
solid
title
Data
UI Text Box
type
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, but may be used as a reference to other LDAP directory types
Section
Column
width
50%
Column
width
50%
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=*))
2. Set the Search Attribute to the directory attribute that contains the user ID to be retrieved
UI Text Box
type
info
Once the end-user authenticates, the ID from the Search Attribute is provided as the forgotten username
Skip to step 6
UI Tab
title
SQL-type Data Stores
UI Text Box
type
info
This is a configuration example using a SQL Data Store integration and common properties, so it is not universal for every enterprise data store, but may be used as a reference to other SQL-type data stores (Oracle, ODBC, others)
Panel
borderColor
#126591
bgColor
white
titleColor
white
borderWidth
1
titleBGColor
#126591
borderStyle
solid
title
SQL Data Store Configuration Steps
1. In the SQL data store, create new Stored Procedures that are specific for the Forgot Username realm, using email (or another preferred property) as the user ID
Using SecureAuth's provided Stored Procedures and Tables, replace the Stored Procedure name with a friendly name, e.g. replace GetUser with GetUserByEmail in sp_GetUser: sp_GetUserByEmail
This differentiates the Stored Procedure from the others that employ the username as the User ID
Replace UserName with Email1 in WHERE UserName = @UserName: WHERE Email1 = @UserName
This tells SecureAuth IdP to employ the user's email address stored in Email 1 as the user ID
Code Block
language
sql
CREATE PROC [dbo].[sp_GetUserByEmail] @UserName VARCHAR(60)
AS
BEGIN
SELECT [UserName]
,ISNULL([GroupList], '')
,ISNULL([PwdLastSet],'1/1/1900')
,ISNULL([AccountStatus], '')
FROM UserTable
WHERE Email1 = @UserName
END
UI Text Box
type
info
Shown as an example is the Get User Stored Procedure, which must be updated for this realm
The following Stored Procedures must be updated in the same manner, but with unique, friendly names:
Get User (new name: GetUserByEmail)
Get Profile (new name: GetProfileByEmail)
Update Profile (new name: UpdateProfileByEmail)
Validate / Get Password, required only if the user's password is required in the workflow to retrieve the forgotten username (new name: ValidatePasswordByEmail / GetPasswordByEmail)
Note the updates applied to this Stored Procedure from step 1
UI Text Box
type
info
The following steps are completed in the SecureAuth IdP Web Admin
Panel
borderColor
#126591
bgColor
white
titleColor
white
borderWidth
1
titleBGColor
#126591
borderStyle
solid
title
Data
Section
Column
width
50%
Column
3. In the Membership Connection Settings section, set the Get User SP to the friendly name of the Forgot Username-specific Get User Stored Procedure (configured in step 1), e.g. GetUserByEmail
4. Set the Validate / Get Password SP to the friendly name of the Forgot Username-specific Get / Validate Password Stored Procedure, e.g. GetPasswordByEmail
UI Text Box
type
info
Step 4 is required only if the user's password is required in the Forgot Username realm login workflow
Panel
borderColor
#3e7fa0
bgColor
white
titleColor
white
borderWidth
1
titleBGColor
#3e7fa0
borderStyle
solid
title
Profile Connection Settings
Section
Column
width
50%
Column
5. Set the Get Profile SP and the Update Profile SP to the friendly names of the Forgot Username-specific Get User Profile and Update User Profile Stored Procedures, e.g. GetProfileByEmail and UpdateProfileByEmail
UI Text Box
type
warning
Click Save once the configurations have been completed and before leaving the Data page to avoid losing changes
Panel
borderColor
#126591
bgColor
white
titleColor
white
borderWidth
1
titleBGColor
#126591
borderStyle
solid
title
Post Authentication
Section
Column
width
50%
Column
6. Select Forgot Username from the Authenticated User Redirect dropdown in the Post Authentication tab in the Web Admin
7. An unalterable URL is auto-populated in the Redirect To field, which appends to the domain name and realm number in the address bar (Authorized/ForgotUsername.aspx)
Panel
borderColor
#3e7fa0
bgColor
white
titleColor
white
borderWidth
1
titleBGColor
#3e7fa0
borderStyle
solid
title
Forgot Username
Section
Column
width
50%
Column
8. Choose the Username Delivery Option, which either is to Display on page or to Send in email to the field designated in the searchFilter / Stored Procedures (Email 1)
UI Text Box
type
info
The username displayed on the page or sent in the email is the username stored in the directory attribute mapped to the Search Attribute field; or the User ID stored as the UserName in SQL-type data stores
UI Text Box
type
warning
Click Save once the configurations have been completed and before leaving the Post Authentication page to avoid losing changes
Panel
borderColor
#3e7fa0
bgColor
white
titleColor
white
borderWidth
1
titleBGColor
#3e7fa0
borderStyle
solid
title
Forms Auth / SSO Token
Section
Column
width
50%
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)