Customizing template pages

Overview

IBM Security Verify Access OIDC Provider uses template pages. The ready-to-use templates are used to display errors and to display user consent. User might add more pages that can be used. For example, by access policy challenge or deny action.

The templates are separated by language. The default language is in the C folder, and it contains all the html templates, labels.properties and the static folder. The language folders only contain the labels.properties file, which contain all the static labels in the form of key,value pairs for the respective locale.

Templates are laid out in the following structure:

<mounted-volume>
  |
  - templates
      |
      - C
        |
        - ciba_user_authorize_failed.html
        - ciba_user_authorize_success.html
        - form_post.html
        - labels.properties
        - user_consent.html
        - user_error.html
        - static
            |
            - ibm-logo.png
            - oauth_response.js
            - styles.css
      - cs
        |
        - labels.properties
      - de
        |
        - labels.properties      
      - es
        |
        - labels.properties      
      - fr
        |
        - labels.properties      
      - hu
        |
        - labels.properties      
      - it
        |
        - labels.properties      
      - ja
        |
        - labels.properties      
      - ko
        |
        - labels.properties      
      - pl
        |
        - labels.properties      
      - pt_BR
        |
        - labels.properties      
      - ru
        |
        - labels.properties      
      - zh_CN
        |
        - labels.properties      
      - zh_TW
        |
        - labels.properties

Customizing page templates

The styles.css under C/static should be updated to update the style sheet for all locales. A new style sheet can also be created and referenced in the html.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
...
    <link rel="stylesheet" type="text/css" href="/oauth2/static/newstyles.css" />

A new logo can be added into the C/static folder and referenced in the user_consent.html and this would update logos in user_consent.html for all locales.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  ...

      <div class="brandingLogo"><img alt="$TEXT_COMPANY_LOGO$" src="/oauth2/static/consent-logo.png" /></div>
    </div>

Template page macros can also customized using template macros
Once the pages are customized the templates directory should be volume mounted.
If the runtime flow results in an unsupported locale, it will default to C.
If the templates directory is not found within /var/isvaop/config/, it will default to using default template file that are embedded within the container image.