Modify user consent page

You can customize the IBM® Verify user consent page for your business. IBM Verify provides the user consent page to allow applications to present an End User License Agreement (EULA) to the user for their consent.

For more information, see Managing end user license agreements and Managing data privacy and consent.

To update the user consent page, 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 Verify user consent page is located in the templates\authentication\login\consent\default\user_consent.html directory within the themes compressed file.

Labels

The following labels are available on this page. To update the text on these labels, see Customizing labels.
  • $AUTH_CONSENT_PAGE_TITLE$
  • $PRIVACY_CONSENT_TEXT_WELCOME$
  • $PRIVACY_CONSENT_TEXT_HEADER$
  • $PRIVACY_CONSENT_TEXT_LOGIN$
  • $PRIVACY_CONSENT_TEXT_LOGOUT$
  • $PRIVACY_AUTH_CONSENT_TEXT_SUBHEADER$
  • $CONTINUE_BUTTON$
  • $CANCEL_BUTTON$
Note:

Overwrite labels are also available when customizing your user consent page.

You can overwrite any consent prompt by using the $PRIVACY_CUSTOM_CONSENT_PROMPT_<purposeId>$ label.

The overwrite text for each consent is on a per-purpose level.

For example, 
$PRIVACY_CUSTOM_CONSENT_PROMPT_marketing$=Allow marketing and promotional material to be sent to my {attribute}.
The label can contain the following macros:
  • `{purpose}` that resolves to the purpose name.
  • `{accesstype}` that resolves to an access type name.
  • `{attribute}` that resolves to an attribute name.
  • `{purpose-description}` that resolves to the purpose description.
  • `{value}` that resolves to an attribute value.
If the macro cannot be resolved to a value, it is replaced with empty string.

Add your overwrite label to the template_labels.properties file as described in Customizing labels.

Macros

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

Table 1. Macro definitions
Macro Value that replaces the macro
@ACTION@ Action taken.
@FAMILYNAME@ Authenticated user surname.
@GIVENNAME@ Authenticated user given name.
@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.
@PREFERNAME@ Authenticated user preferred name.
@PRIVACY_SCOPE_ACCESSTYPE_REPEAT@ The privacy access type to be consented.
@PRIVACY_SCOPE_ATTR_REPEAT@ The attribute to be consented.
@PRIVACY_SCOPE_ATTRVALUE_REPEAT@ The attribute value to be consented.
@PRIVACY_SCOPE_DESC_ALT_REPEAT@ Custom description of the privacy scope to be consented.
@PRIVACY_SCOPE_DESC_REPEAT@ Description of the privacy scope to be consented.
@PRIVACY_SCOPE_PNAME_REPEAT@ Parameter name of the privacy scope to be consented.
@PRIVACY_SCOPE_PSTATE_REPEAT@ Parameter name of the state of the privacy purpose to be consented.
@PRIVACY_SCOPE_PURPOSE_REPEAT@ The privacy purpose to be consented.
@PRIVACY_SCOPE_REQUIRED_REPEAT@ Whether this privacy scope needs to be consented.
@PRIVACY_SCOPE_REPEAT@ Privacy scope to be consented.
@PRIVACY_SCOPE_STATE_REPEAT@ Value of the state of the privacy scope to be consented.
@PRIVACY_SCOPE_TERMSOFUSE_REPEAT@ The terms of use URI of the EULA.
@THEME_ID@ The ID of the registered template theme.
@USERNAME@ The user login ID.

To change the page header, footer, and style on the user consent page, see Create common branding.