Skip to main content

Configure Wallet Web UI

The Wallet Web UI is used by any Resource Owner to manage their FPX Wallet Account. The settings detailed in this section of the guide allow an FPX Wallet administrator to define not only the look and feel, but also several functional aspects of the Wallet UI for a customized, user experience.

The following code block represents a sample instance of the walletui.config parameter under the Wallet deployment YAML file. The code example is followed by details of each parameter along with the accepted values. Where applicable, sample images have been provided to demonstrate the impact of the settings within the Wallet Web UI.

Localization configuration for the Wellet Web UI is detailed in the Language Configuration section.

{
"url": "https://wallet.wa-4130.dev.identos.ca",
"analytics_config": {
"alias": "azureai",
"instrumentationKey": "53279cb7-b053-4f83-b308-6eb380ee2620"
},
"client_id": "wallet-identos-clientid",
"authorization_code_inputs": 6,
"connectionsPagination": 15,
"connectionsDetailsPagination": 15,
"whitelabel": "/config-styles/whitelabel.iaa.css",
"theme": "com.identos.nav.niagara",
"favicon": "/assets/favicon.ico",
"logout_url": "https://idstore.rs.dev.identos.ca/auth/realms/user-portal/protocol/openid-connect/logout",
"profile_configs": {
"name": true,
"description": true,
"gradient_color_1": "#669ecc",
"gradient_color_2": "#334f66",
"notifications": false,
"numberOfNotificationToShow": 2
},
"consent_configs": {
"enable_source_toggle": true,
"enable_scope_toggle": true,
"success_redirect_timeout": 5000,
"enable_change_button": true
},
"my_activity_configs": {
"multiple_accounts_enable": true
},
"setting_configs": [{
"header": "settings__account_title",
"items": [
{
"image_url": "",
"type": "current_account",
"subtitle": "settings__current_account_subtitle",
"has_arrow": false
},
{
"image_url": "",
"title": "settings__managed_account_title",
"type": "managed_accounts",
"subtitle": "settings__managed_account_subtitle",
"has_arrow": true
}
]
},
{
"header": "settings__more_title",
"items": [
{
"type": "logout",
"image_url": "",
"title": "logout__logout"
},
{
"type": "delete_account",
"image_url": "",
"title": "settings__delete_account_title"
"reasons": [
"settings__delete_account_modal_select_option_1_label",
"settings__delete_account_modal_select_option_2_label",
"settings__delete_account_modal_select_option_3_label",
"settings__delete_account_modal_select_option_4_label",
]
},
{
"type": "support",
"link": {
"url": "https://google.com",
"is_external": true
},
"title": "settings__support_title",
"has_arrow": false
}]
}]
}

General Config Section

ParameterDescriptionAccepted Values (Default)
urlAPI Server URL.URL of the API server (https://wallet.wa-4130.dev.identos.ca)
analytics_config.aliasAnalytics service account alias name.Alpha-numeric string (azureai)
analytics_config.instrumentationKeyAnalytics service account instrumentation key.Alpha-numeric string ()
client_idUnique client ID required for device authorization when the Wallet Server makes the /device/token call to the Wallet UI. This must match the OAuth Client ID specified during the Wallet OAuth Client creation step.Alpha-numeric string (wallet-identos-clientid)
authorization_code_inputsNumber of code input fields for the Confirm Authorization page.
Note:*This value is currently hardcoded at 6 at the Wallet Server level and should not be changed in this parameter. Future versions of the Wallet will allow greater levels of customization.*
Any positive integer (Restricted to the default of 6 currently.)
connectionsPaginationDefines the number of connection items to show for pagination on the Connection page.
Sample Image - value set to 5
Any positive integer (15)
connectionsDetailsPaginationDefines the limit of account resources items to show for pagination on the Connection Details page.Any positive integer (15)
whitelabelPath for the client CSS file. The whitelabel.css file allows any default CSS elements that are preconfigured with a new deployment of FPX Wallet Web UI to be easily overridden. For the whitelabel.css styles to take precendence over others, it is mandatory to add the "!important" suffix to each style. The whitelabel.css file configured like any other standard CSS file.File path/URL (/config-styles/whitelabel.css)
themeTheme (primary colour) for the Sign-in page.Alpha-numeric string (com.identos.nav.niagara)
faviconIcon file (*.ico) that will be associated with the deployed Wallet instance.Favicon filename with extension (favicon.ico)
logout_urlURL to logout a user.Alpha-numeric string ()

Profile Config Section

ParameterDescriptionSuggested Value (Default)
profile_configs.nameShow/Hide the signed-in user name in the profile card on the Profile page.
Sample Image
true/false (true)
profile_configs.descriptionShow/Hide the description below the profile card on the Profile page.
Sample Image
true/false (true)
profile_configs.gradient_color_1Gradient color 1 for the profile card background on the Profile page.Hex value for colour (#666666)
profile_configs.gradient_color_2Gradient color 2 for the profile card background on the Profile page.Hex value for colour (#666666)
profile_configs.notificationsShow/Hide notifications on the Profile page.
Sample Image
true/false (false)
profile_configs.numberOfNotificationToShowDefines the number of notification items to show for pagination on the Profile page.Any positive integer (2)
ParameterDescriptionSuggested Value (Default)
consent_configs.enable_source_toggleShow/Hide the toggle button for disabling a source on the Consent page.
Sample image
true/false (true)
consent_configs.enable_scope_toggleShow/Hide the toggle button for disabling scope on the Consent page.
Sample image
true/false (true)
consent_configs.succes_redirect_timeoutThe number of milliseconds to wait before closing the Success modal after successfully submitting the permissions on the Consent page.Timeout value in milliseconds (5000)
consent_configs.enable_change_buttonShow/hide the 'Change' button on Consent page. The 'Change' button gives user the ability to switch the information source.
Sample Image
true/false (true)
my_activity_configs.multiple_accounts_enableEnable/Disable the ability to connect multiple accounts for same data source.
Sample image
true/false (true)

Setting_configs Section

ParameterDescriptionSuggested Value (Default)
setting_configs.headerTitle of each section.Alpha-numeric string ()
setting_configs.items.image_urlPath to the icon image for each item.URL/Path of the icon image
setting_configs.items.titleTitle for the item.Alpha-numeric string ()
setting_configs.items.typeIdentifier for each item. This is for internal code reference and will not display on-screen.

  • Sample image - 'current_account' and 'managed_account'

  • Sample image - Delete Account

  • Sample image - Logout

  • Sample image - Other string, e.g. Support
  • Out-of-the-box values with existing Wallet UI functionality are 'current_account', 'managed_accounts', 'delete_account' and 'logout'. The parameter also supports any other string that can be configured to perform other functions, for example, link to external reference sites. (managed_accounts)
    setting_configs.items.subtitleDescription for the item.
    Sample image
    Alpha-numeric string ()
    setting_configs.items.has_arrowShow/Hide visual arrow icon for for links.
    Sample image
    true/false (true)
    setting_configs.items.link.urlURL for the item if the item is supposed to be a hyperlink.Valid hyperlink
    setting_configs.items.link.is_externalIf set to 'true', the user is informed and redirected outside the Wallet.true/false (true)
    setting_configs.items.reasonsAllows you to specify up to four reasons for deleting a Wallet account.
    Applicable ONLY when the setting_configs.items.type is set to 'delete_account'.
    Sample image
    Any string value