Modify consent collection page

Edit online

You can customize the IBM® Verify consent collection page for your business. Verify provides the consent collection page to allow applications to present user consents and 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 consent collection 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 Uploading individual files with user interface or 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 consent collection page is located in the templates\authentication\consent\default\consent_collection.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

  • $PRIVACY_CONSENT_COLL_PAGE_TITLE$
  • $PRIVACY_CONSENT_TEXT_WELCOME$
  • $PRIVACY_CONSENT_TEXT_HEADER$
  • $PRIVACY_CONSENT_TEXT_LOGIN$
  • $PRIVACY_CONSENT_TEXT_LOGOUT$
  • $PRIVACY_CONSENT_COLL_TEXT_SUBHEADER$
  • $CONTINUE_BUTTON$
  • $CANCEL_BUTTON$
Note:

Overwrite labels are also available when customizing your consent collection 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.
If the macro cannot be resolved to a value, it is replaced with an 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
@FORM_POST_URL@ The URL where the consent form is submitted.
@FAMILYNAME@ Authenticated user's surname.
@GIVENNAME@ Authenticated user's 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's preferred name.
@PRIVACY_CONSENT_NAME@ Parameter name of the consent.
@PRIVACY_CONSENT_VALUE@ The value of the consent key in the format: purposeId/attributeId.accessTypeId#.
@PRIVACY_CONSENT_STATE_VALUE@ The state value of the consent (for example, CONSENT_ALLOW, CONSENT_DENY, OPT_IN, OPT_OUT, TRANSPARENCY).
@PRIVACY_CONSENT_REQUIRED@ Indicates whether this privacy consent is mandatory.
@PRIVACY_CONSENT_DESC@ Description of the privacy consent.
@CHECKBOX_STYLE@ The style to be applied to the checkbox. This is used to show or hide the checkbox.
@CHECKBOX_OPTION@ Indicates whether the checkbox should be checked or disabled, and defines the associated action events.
@APPROVAL_STYLE@ Specifies whether the '(Required)' label is displayed for the consent item.
@THEME_ID@ The ID of the registered template theme.
@USERNAME@ The user's login ID.

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