Modify login error pages
You can customize the IBM® Security Verify login error pages for your business. The login error pages are displayed to the user when there's an authentication error during login.
To update the login error pages, download the compressed theme file. Edit the pages as needed and then upload the updated themes file back to your tenant. For more information, 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 login error pages are located in the templates\authentication\login\error\default\ directory within the themes compressed file.
The following login error pages are available for customization:
This page is displayed during login when a generic error occurs during authentication. Update the generic_login_error.html file to modify the page.
- $GENERIC_ERROR_TITLE$
- $GENERIC_ERROR_HEADER$
- $GENERIC_ERROR_OCCURRED_AT$
- $GENERIC_ERROR_REQUEST_ADDRESS$
- $GENERIC_ERROR_ERROR_DETAILS$
- $GENERIC_ERROR_CONTACT_SUPPORT$
- $GENERIC_ERROR_SUPPORT_URL$
- $GENERIC_ERROR_VIEW_DETAILS$
- $GENERIC_ERROR_HIDE_DETAILS$
The macros for this page are shown in the following table.
Macro | Value that replaces the macro |
---|---|
@ERROR_MESSAGE@ | An error message that is specific to the action in the page. |
@EXCEPTION_MSG@ | The exception message. |
@PAGE_FOOTER@ | The HTML that contains the footer of the page. This code can be modified by customizing the footer.html common template. |
@PAGE_HEADER@ | The HTML that contains the header of the page. This code can be modified by customizing the header.html common template. |
@REQ_ADDR@ | The URL into which the request from the user is sent. |
@THEME_ID@ | The ID of the registered template theme. |
@TIMESTAMP@ | The timestamp when the error occurred. |
The page is displayed during login when there's an error during authentication. Update the login_error.html file to modify the page.
- $LOGIN_ERROR_TITLE$
- $LOGIN_ERROR_HEADER$
- $GENERIC_ERROR_OCCURRED_AT$
- $GENERIC_ERROR_REQUEST_ADDRESS$
- $GENERIC_ERROR_ERROR_DETAILS$
- $GENERIC_ERROR_CONTACT_SUPPORT$
- $GENERIC_ERROR_SUPPORT_URL$
- $GENERIC_ERROR_VIEW_DETAILS$
- $GENERIC_ERROR_HIDE_DETAILS$
- $LOGIN_ERROR_TRY_AGAIN$
The macros for this page are shown in the following table.
Macro | Value that replaces the macro |
---|---|
@ERROR_MESSAGE@ | An error message that is specific to the action in the page. |
@EXCEPTION_MSG@ | The exception message. |
@IDAAS_LOGIN_URL@ | The Login URL, if any. |
@PAGE_FOOTER@ | The HTML that contains the footer of the page. This code can be modified by customizing the footer.html common template. |
@PAGE_HEADER@ | The HTML that contains the header of the page. This code can be modified by customizing the header.html common template. |
@PROVIDED_EMAIL@ | The email of the user attempting to login. |
@PROVIDED_FAMILY_NAME@ | The family name of the user attempting to login. |
@PROVIDED_GIVEN_NAME@ | The given name of the user attempting to login. |
@PROVIDED_PREFERRED_USERNAME@ | The username of the user attempting to login. |
@REQ_ADDR@ | The URL into which the request from the user is sent. |
@THEME_ID@ | The ID of the registered template theme. |
@TIMESTAMP@ | The timestamp when the error occurred. |
This page is displayed during login when there's a token error during authentication. Update the token_error.html file to modify the page.
- $GENERIC_ERROR_TITLE$
- $GENERIC_ERROR_HEADER$
- $LOGIN_ERROR_TRY_AGAIN$
The macros for this page are shown in the following table.
Macro | Value that replaces the macro |
---|---|
@ERROR_MESSAGE@ | An error message that is specific to the action in the page. |
@PAGE_FOOTER@ | The HTML that contains the footer of the page. This code can be modified by customizing the footer.html common template. |
@PAGE_HEADER@ | The HTML that contains the header of the page. This code can be modified by customizing the header.html common template. |
@REDIRECT_URL@ | The redirect URL sent to allow the user to login again. |
@THEME_ID@ | The ID of the registered template theme. |
@TOKEN_ERROR_MESSAGE@ | The token error message. |
To change the page header, footer, and style on the login error pages, see Create common branding.