PhenixID DocumentationPhenixID Authentication ServicesSolutions PhenixID Pocket PassAdd branding to Pocket Pass (and OneTouch OTP profiles)

Add branding to Pocket Pass (and OneTouch OTP profiles)

PhenixID Pocket Pass comes with branding capabilities, such as customized images and colors.

Also, applicable from version 3.2 of PhenixID Authentication Services an version 4.2 of PhenixID OneTouch, it is possible to add OTP (OATH) profiles to PhenixID OneTouch. OneTouch OTP profiles are also brandable, using the same configuration settings.

The branding settings will be downloaded and added to the app(s) during activation.

This solution document will describe how to enable this feature.

Add branding settings

In order to add branding (customized images and colors) to PhenixID Pocket Pass and/or PhenixID OneTouch (profile), the images need to be added to a web server which can be reached publicly.

Also, a json settings file containing pointers to the images and color specifications must be created and added to a web server and exposed publicly.

Settings file data format

The settings file is in json format.

An example:

{
    "image_background_portrait":"https://demo.phenixid.net/otsettings/portrait.jpg",
    "image_background_landscape":"https://demo.phenixid.net/otsettings/landscape.jpg",
    "image_logo_portrait":"https://demo.phenixid.net/otsettings/logo_portrait.jpg",
    "image_logo_landscape":"https://demo.phenixid.net/otsettings/logo_landscape.jpg",
    "image_icon":"https://demo.phenixid.net/otsettings/logo.jpg",
    "color_text":"#ffffffff",
    "color_text_shadow":"#ff444444",
    "color_timebar":"#ffffffff",
    "color_timebar_background":"#ff333333",
    "color_button_text":"#ff000000",
    "color_button_background":"#ffffffff"
}

Images

Images must be exactly the size specified below, and in jpeg or png format. Jpeg is probably the best choice due to its smaller size.

Colors

The format of all colors must be #aarrggbb. The aa (alpha-value) of the color is preferably set to ff.

Description of the parameters:

image_background_portrait - required

The background image used in portrait mode. The image size must be 720x1280 pixels.

image_background_landscape - required

The background image used in landscape mode. The image size must be 1280x720 pixels.

color_text - required

The color of the one-time password text.

color_text_shadow - required

The color of the one-time password text shadow.

color_timebar - required

The color of the one-time password time bar (When using time-based one-time passwords).

color_timebar_background - required

The background color of the one-time password time bar.

color_button_text - required

The color of the one-time password button text (When using counter-based one-time passwords).

color_button_background - required

The background color of the one-time password button text.

 

 

PhenixID provides an example template online. To use it use the URL:  https://demo.phenixid.net/otsettings/settings.json

Configuring

Use the settings file by entering the URL to the settings file in the PhenixID Authentication Services configuration.

Note that this URL must be reachable by the apps at the time of activation. 

 The url must be set for the application(s) used for app activation. See details below.

Self Service / MFA Admin

Configuring

Pocket Pass enrollment application

Login to Configuration Manager

Open the Advanced tab

Open the Modules section

Locate the enroll-oath section

Add the settings_url to the configuration block.

OneTouch enrollment application

Login to Configuration Manager

Open the Advanced tab

Open the Modules section

Locate the enroll-pki section

Add the settings_url to the configuration block.

Testing

Test it by activating PhenixID Pocket Pass and/or PhenixID OneTouch, using the activation application(s) configured (see above).

Verify that the GUI displays the images and colors defined in the settings file.