Modify forgot username pages

You can customize the IBM® Security Verify forgot username pages for your business.

To update the forgot username pages, download the compressed themes file. Edit the pages as needed and then upload the updated themes file back to your tenant. For details, see Updating a theme.

Text changes can be made to the pages by using HTML markup. The HTML files also contain macros. Macros are characters between the @ symbol where the data is rendered at run time. Do not change the macros in the files.

The IBM Security Verify username pages for English are located in the templates\authentication\login\cloud_directory\username\forgot_username\default\ directory within the compressed theme file. The translated pages that are available are located in the templates\authentication\login\cloud_directory\username\forogt_username\<locale>\ directories within the compressed theme file.

You can customize the following username pages:

Modify forgot username page

This page is displayed when the user requests help with a forgotten username. Update the forgot_username.html file to modify the page.

The following labels are available on the forgot username page. To update the text on these labels, see Customizing labels.
  • $FORGOT_USERNAME_LABEL$
  • $FORGOT_USERNAME_DETAILS$
  • $FORGOT_USERNAME_CONTINUE$
  • $FORGOT_USERNAME_CANCEL$

The macros for this page are shown in the following table.

Table 1. Macro definitions
Macro Value that replaces the macro
@PAGE_HEADER@ The HTML that contains the header of the page. This code can be modified by customizing the header.html common template.
@LABEL_USERNAME_RECOVERY_ATTR@ The label name for the username recovery attributes.
@PAGE_FOOTER@ The HTML that contains the footer of the page. This code can be modified by customizing the footer.html common template.
Modify forgot username success page

This page is displayed when the forgotten username is changed. Update the forgot_username_success.html file to modify the page.

The following labels are available on the username success page. To update the text on these labels, see Customizing labels.
  • $PRODUCT_NAME$
  • $FORGOT_USERNAME_RETURN_HOME$

The macros for this page are shown in the following table.

Table 2. Macro definitions
Macro Value that replaces the macro
@PAGE_HEADER@ The HTML that contains the header of the page. This code can be modified by customizing the header.html common template.
@LABEL_TITLE@ The page title.
@MESSAGE@ A message to display additional information.
@PAGE_FOOTER@ The HTML that contains the footer of the page. This code can be modified by customizing the footer.html common template.
Modify username recovery email page

The email sent to the user with a link to reset the username. Update the username_recovery_email.xml file to modify the page.

The following label is available on the user recovery no account email page. To update the text on this label, see Customizing labels.
  • $PRODUCT_NAME$

The macros for this page are shown in the following table.

Table 3. Macro definitions
Macro Value that replaces the macro
@FIRST_NAME@ The first name of the user.
@TENANT@ The name of the tenant.
@USERNAME@ The username of the user.
@LOCATION@ The location of the requestor based on the IP address.
@USER_AGENT@ The device details of the requestor.
@IP_ADDRESS@ The requesting IP address.
Modify user recovery no account exists page

The email sent to the user when the account does not exist. Update the username_recovery_noaccount_email.xml file to modify the page.

The following label is available on the password recovery email page. To update the text on this label, see Customizing labels.
  • $PRODUCT_NAME$

The macros for this page are shown in the following table.

Table 4. Macro definitions
Macro Value that replaces the macro
@TENANT@ The name of the tenant.

To change the page header, footer, and style for the username pages, see Create common branding.