Modify user notification pages

You can customize the IBM Security® Verify user notification pages for your business. User notification pages are sent to the user when a user is created, deleted, or modified.

To update the user notification pages, download the compressed theme file. Edit the pages as needed and then upload the updated theme files back to your Verify tenant. For more information, see Updating a theme.

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

The IBM Security Verify user notification pages are in the templates/notifications/user_management/profile/ directory within the themes compressed file.

email

User email notifications are available for user add, remove, and update activities. The pages are in the templates/notifications/user_management/profile/default directory.

Note: Federated user members do not get an email notification.
The following label is available on the user email notification pages. To update the text on these labels, see Customizing labels.
  • $PRODUCT_NAME$

The user email notifications pages are:

User created email pages

This email page is sent to the user when the user is created. Update the account_created_email.xml and account_created_email_with_no_password.xml files to modify the pages.

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

Table 1. Macro definitions
Macro Value that replaces the macro
@USERNAME@ The user's name.
@PASSWORD@ The user’s temporary password.
@LOGIN_PAGE_LINK@ The Verify tenant URL sent to allow the user to login.
Table 2. Common macro definitions
Common macro Value that replaces the macro
@LANG_QUERY_PARAM@ The preferred language to use for email notification or use for the value of the lang query parameter for Verify APIs.
@TENANT@ The name of the Verify tenant.
@TENANT_URL@ The Verify tenant URL sent to allow the user to login.
@THEME_ID@ The identifier of the theme that you want to apply or use for the value of the themeId query parameter for Verify APIs.
User deleted email page

This email page is sent to the user when the user is deleted. Update the account_deleted_email.xml file to modify the page.

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

Table 3. Macro definitions
Macro Value that replaces the macro
@USERNAME@ The user's name.
Table 4. Common macro definitions
Common macro Value that replaces the macro
@LANG_QUERY_PARAM@ The preferred language to use for email notification or use for the value of the lang query parameter for Verify APIs.
@TENANT@ The name of the Verify tenant.
@TENANT_URL@ The Verify tenant URL sent to allow the user to login.
@THEME_ID@ The identifier of the theme that you want to apply or use for the value of the themeId query parameter for Verify APIs.
User modified email page

This email page is sent to the user when the user’s profile is modified. Update the user_profile_modified_email.xml file to modify the page.

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

Table 5. Macro definitions
Macro Value that replaces the macro
@ATTRS_TABLEROWS@ The user’s attributes that were updated.
@USERNAME@ The user's name.
Table 6. Common macro definitions
Common macro Value that replaces the macro
@LANG_QUERY_PARAM@ The preferred language to use for email notification or use for the value of the lang query parameter for Verify APIs.
@TENANT@ The name of the Verify tenant.
@TENANT_URL@ The Verify tenant URL sent to allow the user to login.
@THEME_ID@ The identifier of the theme that you want to apply or use for the value of the themeId query parameter for Verify APIs.
User account locked email page

This email page is sent to the user’s account is locked. Update the user_account_locked_email.xml file to modify the page.

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

Note: The user’s ability to reset the password for their account is controlled by the Cloud Directory Identity Provider’s password reset setting.
Table 7. Common macro definitions
Macro Value that replaces the macro
@ PWD_ACCOUNT_LOCKED_TIME@ The time the user’s account was locked because of too many failed password attempts.
@USERNAME@ The user's name.
@RESET_PWD_LINK@ The URL to reset the user’s password if the Cloud Directory Identity Provider’s password reset setting is enabled.
@DISPLAY_RESET_ENABLED@ inherit or none based on the Cloud Directory Identity Provider’s password reset setting.
@DISPLAY_RESET_NOT_ENABLED@ inherit or none based on the Cloud Directory Identity Provider’s password reset setting.
Table 8. Common macro definitions
Common macro Value that replaces the macro
@LANG_QUERY_PARAM@ The preferred language to use for email notification or use for the value of the lang query parameter for Verify APIs.
@TENANT@ The name of the Verify tenant.
@TENANT_URL@ The Verify tenant URL sent to allow the user to login.
@THEME_ID@ The identifier of the theme that you want to apply or use for the value of the themeId query parameter for Verify APIs.

See Personalize themes with user attributes to add more customizations to your user email notification pages.