aam authentication portal

Authentication portal configuration

This object allows you to customize the default Authentication Portal. You are able to configure how the background, company logo, and text of are displayed.

portal Specification

Type Collection
Object Key(s) name
Collection Name portal-list
Collection URI /axapi/v3/aam/authentication/portal/
Element Name portal
Element URI /axapi/v3/aam/authentication/portal/{name}
Element Attributes portal_attributes
Schema portal schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/aam/authentication/portal/

portal Attributes

Create List

POST

/axapi/v3/aam/authentication/portal/

portal Attributes

Get Object

GET

/axapi/v3/aam/authentication/portal/{name}

portal Attributes

Get List

GET

/axapi/v3/aam/authentication/portal/

portal-list

Modify Object

POST

/axapi/v3/aam/authentication/portal/{name}

portal Attributes

Replace Object

PUT

/axapi/v3/aam/authentication/portal/{name}

portal Attributes

Replace List

PUT

/axapi/v3/aam/authentication/portal/

portal-list

Delete Object

DELETE

/axapi/v3/aam/authentication/portal/{name}

portal Attributes

portal-list

portal-list is JSON List of portal Attributes

portal-list : [

portal Attributes

change-password

Description: change-password is a JSON Block . Please see below for change-password

Type: Object

Reference Object: /axapi/v3/aam/authentication/portal/{name}/change-password

logo-cfg

Description: logo-cfg is a JSON Block . Please see below for logo-cfg

Type: Object

logon

Description: logon is a JSON Block . Please see below for logon

Type: Object

Reference Object: /axapi/v3/aam/authentication/portal/{name}/logon

logon-fail

Description: logon-fail is a JSON Block . Please see below for logon-fail

Type: Object

Reference Object: /axapi/v3/aam/authentication/portal/{name}/logon-fail

name

Description: This command allows you to change how the default portal Logo is displayed.

Type: string

Supported Values: default-portal

Required: Yes

reset-change-password

Description: reset-change-password is a JSON Block . Please see below for reset-change-password

Type: Object

Reference Object: /axapi/v3/aam/authentication/portal/{name}/reset-change-password

reset-logon

Description: reset-logon is a JSON Block . Please see below for reset-logon

Type: Object

Reference Object: /axapi/v3/aam/authentication/portal/{name}/reset-logon

reset-logon-fail

Description: reset-logon-fail is a JSON Block . Please see below for reset-logon-fail

Type: Object

Reference Object: /axapi/v3/aam/authentication/portal/{name}/reset-logon-fail

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

logon-fail

Specification
Type object

background

Description: background is a JSON Block . Please see below for l1062_background

Type: Object

fail-msg-cfg

Description: fail-msg-cfg is a JSON Block . Please see below for l1062_fail-msg-cfg

Type: Object

title-cfg

Description: title-cfg is a JSON Block . Please see below for l1062_title-cfg

Type: Object

uuid

Description: uuid of the object

Type: string

logon-fail.fail-msg-cfg

Specification
Type object

fail-color

Description: This variable allows you to specify the new color of the welcome text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-color-name

Description: This command allows you to modify the color of the welcome message text. You can specify one of the following colors:
Aqua, Black, Blue, Fuchsia, Gray, Green Lime, Maroon, Navy Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: fail-color-name and fail-color-value are mutually exclusive

fail-color-value

Description: This command allows you to specify a 6-digit HEX color value, for example, color #228B22.

Type: string

Mutual Exclusion: fail-color-value and fail-color-name are mutually exclusive

fail-face

Description: This command allows you to modify the font of the welcome message.

Type: string

Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana

Mutual Exclusion: fail-face and fail-font-custom are mutually exclusive

fail-font

Description: This variable allows you to specify the new size of the welcome message text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-font-custom

Description: This command allows you to use a custom font, for example, Tahoma.

Type: string

Format: string-rlx

Mutual Exclusion: fail-font-custom and fail-face are mutually exclusive

fail-msg

Description: This variable allows you to specify the new welcome message.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-size

Description: This variable allows you to specify the new size of the welcome message text.

Type: number

Range: 1-7

fail-text

Description: This command allows you to modify the text of the welcome message.

Type: string

Format: string-rlx

logon-fail.title-cfg

Specification
Type object

title

Description: This variable allows you to specify the title of the Login Failure Page.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

title-color

Description: This variable allows you to specify the new color of the title of the Login Failure page.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

title-color-name

Description: This command allows you to modify the color of the title of the Login Failure page. You can specify one of the following predefined colors:
Aqua, Black, Blue, Fuchsia, Gray, Green Lime, Maroon, Navy Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: title-color-name and title-color-value are mutually exclusive

title-color-value

Description: This command allows you to specify a 6-digit HEX color value, for example, color #228B22.

Type: string

Mutual Exclusion: title-color-value and title-color-name are mutually exclusive

title-face

Description: This command allows you to modify the font of the title of the Login Failure page. You can use one of the predefined fonts:
Arial, Courier New, Georgia, Times New Roman, and Verdana.

Type: string

Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana

Mutual Exclusion: title-face and title-font-custom are mutually exclusive

title-font

Description: This variable allows you to specify a new font of the title of the Login Failure page.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

title-font-custom

Description: This command allows you to use a custom font, for example, Tahoma.

Type: string

Format: string-rlx

Mutual Exclusion: title-font-custom and title-face are mutually exclusive

title-size

Description: This variable allows you to specify the new size of the title of the Login Failure page. You can specify a font size between 1 and 7.

Type: number

Range: 1-7

title-text

Description: This command allows you to modify the title of the Login Failure page.

Type: string

Format: string-rlx

logon-fail.background

Specification
Type object

bgcolor

Description: This variable allows you to specify the new color of the background image.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: bgcolor and bgfile are mutually exclusive

bgcolor-name

Description: This command allows you to modify the color of the background image. You can specify one of the following colors:
Aqua, Black, Blue, Fuchsia, Gray, Green Lime, Maroon, Navy Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: bgcolor-name and bgcolor-value are mutually exclusive

bgcolor-value

Description: This command allows you to specify a 6-digit HEX color value, for example, color #228B22.

Type: string

Mutual Exclusion: bgcolor-value and bgcolor-name are mutually exclusive

bgfile

Description: This command allows you to modify the background image file.

Type: string

Format: string-rlx

Mutual Exclusion: bgfile and bgcolor are mutually exclusive

bgstyle

Description: This command allows you to modify the style of the background image. You can modify the following styles:
Tile, stretch and fit.

Type: string

Supported Values: tile, stretch, fit

logo-cfg

Specification
Type object

height

Description: This variable allows you to specify the width of the logo file.

Type: number

Range: 50-400

logo

Description: This command allows you to replace the default logo file with your logo file.

Type: string

Format: string-rlx

width

Description: This variable allows you to specify the width of the new logo file.

Type: number

Range: 50-400

reset-logon

Specification
Type object

reset

Description:

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

reset-logon-fail

Specification
Type object

reset

Description:

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

reset-change-password

Specification
Type object

reset

Description:

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

logon

Specification
Type object

action-url

Description: This command allows you to change how the form action URL for the Login page is displayed.

Type: string

Format: string-rlx

background

Description: background is a JSON Block . Please see below for l1062_background

Type: Object

enable-passcode

Description: Enable passcode field in default logon page

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-msg-cfg

Description: fail-msg-cfg is a JSON Block . Please see below for l1062_fail-msg-cfg

Type: Object

passcode-cfg

Description: passcode-cfg is a JSON Block . Please see below for l1062_passcode-cfg

Type: Object

passcode-var

Description: Specify passcode variable name in default logon page (Default: passcode)

Type: string

Format: string-rlx

password-cfg

Description: password-cfg is a JSON Block . Please see below for l1062_password-cfg

Type: Object

password-var

Description: This command allows you to change the variable text for the title of the Password.

Type: string

Format: string-rlx

submit-text

Description: This command allows you to configure the text on the button that the user clicks to submit their credentials on the Login page.

Type: string

Format: string-rlx

username-cfg

Description: username-cfg is a JSON Block . Please see below for l1062_username-cfg

Type: Object

username-var

Description: This command allows you to change the variable name of the user name..

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

logon.passcode-cfg

Specification
Type object

passcode

Description: Configure passcode text in default logon page

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

passcode-color

Description: Specify font color

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

passcode-color-name

Description: ‘aqua’: aqua; ‘black’: black; ‘blue’: blue; ‘fuchsia’: fuchsia; ‘gray’: gray; ‘green’: green; ‘lime’: lime; ‘maroon’: maroon; ‘navy’: navy; ‘olive’: olive; ‘orange’: orange; ‘purple’: purple; ‘red’: red; ‘silver’: silver; ‘teal’: teal; ‘white’: white; ‘yellow’: yellow;

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: passcode-color-name and passcode-color-value are mutually exclusive

passcode-color-value

Description: Specify 6-digit HEX color value

Type: string

Mutual Exclusion: passcode-color-value and passcode-color-name are mutually exclusive

passcode-face

Description: ‘Arial’: Arial; ‘Courier_New’: Courier New; ‘Georgia’: Georgia; ‘Times_New_Roman’: Times New Roman; ‘Verdana’: Verdana;

Type: string

Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana

Mutual Exclusion: passcode-face and passcode-font-custom are mutually exclusive

passcode-font

Description: Sepcify font

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

passcode-font-custom

Description: Specify custom font

Type: string

Format: string-rlx

Mutual Exclusion: passcode-font-custom and passcode-face are mutually exclusive

passcode-size

Description: Specify font size

Type: number

Range: 1-7

passcode-text

Description: Specify passcode text (Default: Passcode)

Type: string

Format: string-rlx

logon.background

Specification
Type object

bgcolor

Description: This variable allows you to specify the new color of the background image.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: bgcolor and bgfile are mutually exclusive

bgcolor-name

Description: This command allows you to modify the color of the background image. You can specify one of the following colors:
Aqua, Black, Blue, Fuchsia, Gray, Green, Lime, Maroon, Navy, Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: bgcolor-name and bgcolor-value are mutually exclusive

bgcolor-value

Description: This command allows you to specify a 6-digit HEX color value for a custom color, for example, color #228B22.

Type: string

Mutual Exclusion: bgcolor-value and bgcolor-name are mutually exclusive

bgfile

Description: This command allows access the directory where the login page files are located.

Type: string

Format: string-rlx

Mutual Exclusion: bgfile and bgcolor are mutually exclusive

bgstyle

Description: This command allows you to modify the style of the background image. You can modify the following styles:
Tile, stretch and fit.

Type: string

Supported Values: tile, stretch, fit

logon.fail-msg-cfg

Specification
Type object

authz-fail-msg

Description: Configure authorization failure message in default logon page, its text attributes follow fail-msg’s (Specify authorization failure message (Default: Authorization failed. Please contact your system administrator.))

Type: string

Format: string-rlx

fail-color

Description: This variable allows you to specify the new color of the failure login message text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-color-name

Description: This command allows you to modify the color of the login failure message text. You can specify one of the following colors:
Aqua, Black, Blue, Fuchsia, Gray, Green Lime, Maroon, Navy Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: fail-color-name and fail-color-value are mutually exclusive

fail-color-value

Description: This command allows you to specify a 6-digit HEX color value, for example, color #228B22.

Type: string

Mutual Exclusion: fail-color-value and fail-color-name are mutually exclusive

fail-face

Description: This command allows you to modify the font of the failure message text. You can use one of the following predefined fonts:
Arial, Courier New, Georgia, Times New Roman, and Verdana.

Type: string

Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana

Mutual Exclusion: fail-face and fail-font-custom are mutually exclusive

fail-font

Description: This variable allows you to specify a new font of the login failure message.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-font-custom

Description: This command allows you to specify a custom font for example, Tahoma.

Type: string

Format: string-rlx

Mutual Exclusion: fail-font-custom and fail-face are mutually exclusive

fail-msg

Description: This variable allows you to specify the new failure message text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

fail-size

Description: This variable allows you to specify the new font size. You can specify a font size between 1 and 7.

Type: number

Range: 1-7

fail-text

Description: This command allows you to modify the failure message text.

Type: string

Format: string-rlx

logon.password-cfg

Specification
Type object

pass-color

Description: This variable allows you to specify the new color of the Password field title text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

pass-color-name

Description: This command allows you to modify the color of the Password field title text. You can specify one of the following colors:
Aqua, Black, Blue, Fuchsia, Gray, Green Lime, Maroon, Navy Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: pass-color-name and pass-color-value are mutually exclusive

pass-color-value

Description: This command allows you to specify a custom 6-digit HEX color value, for example, color #228B22.

Type: string

Mutual Exclusion: pass-color-value and pass-color-name are mutually exclusive

pass-face

Description: This command allows you to modify the font of the title of the Password field. You can use one of the following predefined fonts:
Arial, Courier New, Georgia, Times New Roman and Verdana.

Type: string

Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana

Mutual Exclusion: pass-face and pass-font-custom are mutually exclusive

pass-font

Description: This variable allows you to specify a new font for the title of the Password field.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

pass-font-custom

Description: This command allows you to specify a custom font, for example, Tahoma.

Type: string

Format: string-rlx

Mutual Exclusion: pass-font-custom and pass-face are mutually exclusive

pass-size

Description: This variable allows you to specify the new size of the Password field title text.

Type: number

Range: 1-7

pass-text

Description: This command allows you to specify the title of the Password field.

Type: string

Format: string-rlx

password

Description: This variable allows you to specify the new text for the title of the Password field title.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

logon.username-cfg

Specification
Type object

user-color

Description: This variable allows you to specify the new color of the user name field title text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user-color-name

Description: This command allows you to modify the color of the user name field title text. You can specify one of the following colors:
Aqua, Black, Blue, Fuchsia, Gray, Green Lime, Maroon, Navy Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: user-color-name and user-color-value are mutually exclusive

user-color-value

Description: This command allows you to specify a 6-digit HEX color value, for example, color #228B22.

Type: string

Mutual Exclusion: user-color-value and user-color-name are mutually exclusive

user-face

Description: This command allows you to modify the font of the user name field title text. You can use one of the following predefined fonts:
Arial, Courier New, Georgia, Times New Roman or Verdana.

Type: string

Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana

Mutual Exclusion: user-face and user-font-custom are mutually exclusive

user-font

Description: This variable allows you to specify a new font for the user name field title text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user-font-custom

Description: This command allows you to use a custom font for example, Tahoma.

Type: string

Format: string-rlx

Mutual Exclusion: user-font-custom and user-face are mutually exclusive

user-size

Description: This variable allows you to specify a size of the user name field title text. You can specify a font size between 1 and 7.

Type: number

Range: 1-7

user-text

Description: This command allows you to modify the user name field text.

Type: string

Format: string-rlx

username

Description: This command allows you to specify the new user name text in the default Login page.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

change-password

Specification
Type object

action-url

Description: This command allows you to modify the form action URL for the Change Password page.

Type: string

Format: string-rlx

background

Description: background is a JSON Block . Please see below for l1062_background

Type: Object

cfm-pwd-cfg

Description: cfm-pwd-cfg is a JSON Block . Please see below for l1062_cfm-pwd-cfg

Type: Object

confirm-password-var

Description: This command allows you to modify the variable name of the field in which users re-enter their new password for confirmation.

Type: string

Format: string-rlx

new-password-var

Description: This command allows you to modify the variable name of the field in which users enter a new password. You can, for example, change the variable name from User Name to User.

Type: string

Format: string-rlx

new-pwd-cfg

Description: new-pwd-cfg is a JSON Block . Please see below for l1062_new-pwd-cfg

Type: Object

old-password-var

Description: This command allows you to modify the variable name of the field in which users enter their current password.

Type: string

Format: string-rlx

old-pwd-cfg

Description: old-pwd-cfg is a JSON Block . Please see below for l1062_old-pwd-cfg

Type: Object

reset-text

Description: This command allows you to change the text on the button that users click to reset their passwords.

Type: string

Format: string-rlx

submit-text

Description: This command allows you to modify the text on the button that the user clicks to confirm a new password.

Type: string

Format: string-rlx

title-cfg

Description: title-cfg is a JSON Block . Please see below for l1062_title-cfg

Type: Object

username-cfg

Description: username-cfg is a JSON Block . Please see below for l1062_username-cfg

Type: Object

username-var

Description: This command allows you to modify the variable name of the user name on the Change Password page.

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

change-password.new-pwd-cfg

Specification
Type object

new-color

Description: This variable allows you to specify the new color of the title text of the field in which users enter their password.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

new-color-name

Description: This command allows you to modify the color of the title text of the field in which users enter their new password. You can specify one of the following colors:
Aqua, Black, Blue, Fuchsia, Gray, Green Lime, Maroon, Navy Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: new-color-name and new-color-value are mutually exclusive

new-color-value

Description: This command allows you to specify a 6-digit HEX color value, for example, color #228B22.

Type: string

Mutual Exclusion: new-color-value and new-color-name are mutually exclusive

new-face

Description: This command allows you to modify the font of the title text of the field in which users enter their new password. You can use one of the following fonts:
Arial, Courier New, Georgia, Times New Roman, and Verdana.

Type: string

Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana

Mutual Exclusion: new-face and new-font-custom are mutually exclusive

new-font

Description: This variable allows you to specify a new font for the title of the field in which users enter their new password.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

new-font-custom

Description: This command allows you to specify a custom font, for example, Tahoma.

Type: string

Format: string-rlx

Mutual Exclusion: new-font-custom and new-face are mutually exclusive

new-password

Description: This variable allows you to modify the new title text of the field in which users enter their new password.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

new-size

Description: This variable allows you to specify the new size of the title text of the field in which users enter their new password. You can specify a font size between 1 and 7.

Type: number

Range: 1-7

new-text

Description: This command allows you to modify the field in which users enter their new password.

Type: string

Format: string-rlx

change-password.title-cfg

Specification
Type object

title

Description: This variable allows you to specify the new text for the title of the page.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

title-color

Description: This variable allows you to specify the new font color of the title text.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

title-color-name

Description: This command allows you to modify the color of the title text. You can specify one of the following colors:
Aqua, Black, Blue, Fuchsia, Gray, Green Lime, Maroon, Navy Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: title-color-name and title-color-value are mutually exclusive

title-color-value

Description: This command allows you to specify a custom 6-digit HEX color value, for example, color #228B22.

Type: string

Mutual Exclusion: title-color-value and title-color-name are mutually exclusive

title-face

Description: This command allows you to modify the font of the title of the user name field. You can use one of the following predefined fonts:
Arial, Courier New, Georgia, Times New Roman or Verdana.

Type: string

Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana

Mutual Exclusion: title-face and title-font-custom are mutually exclusive

title-font

Description: This variable allows you to specify a new font for the title of the user name field.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

title-font-custom

Description: This command allows you to specify a custom font, for example, Tahoma.

Type: string

Format: string-rlx

Mutual Exclusion: title-font-custom and title-face are mutually exclusive

title-size

Description: This variable allows you to specify the size of the title text. You can specify a font size between 1 and 7.

Type: number

Range: 1-7

title-text

Description: This command allows you to modify the title of the page.

Type: string

Format: string-rlx

change-password.old-pwd-cfg

Specification
Type object

old-color

Description: This variable allows you to specify the new color of the title of the field in which users will enter their current password.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

old-color-name

Description: This command allows you to modify the color of the title text of the field in which users will enter their current password. You can specify one of the following colors:
Aqua, Black, Blue, Fuchsia, Gray, Green Lime, Maroon, Navy Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: old-color-name and old-color-value are mutually exclusive

old-color-value

Description: This command allows you to specify a 6-digit HEX color value, for example, color #228B22.

Type: string

Mutual Exclusion: old-color-value and old-color-name are mutually exclusive

old-face

Description: This command allows you to modify the font of the title text of the field in which users will enter their current password. You can use one of the following predefined fonts:
Arial, Courier New, Georgia, Times New Roman and Verdana.

Type: string

Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana

Mutual Exclusion: old-face and old-font-custom are mutually exclusive

old-font

Description: This variable allows you to specify a new font of the title text of the field in which users will enter their current password.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

old-font-custom

Description: This command allows you to use a custom font, for example, Tahoma.

Type: string

Format: string-rlx

Mutual Exclusion: old-font-custom and old-face are mutually exclusive

old-password

Description: This variable allows you to specify the new title text of the field in which users will enter their current password.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

old-size

Description: This variable allows you to specify the new size of the title text of the field in which users will enter their current password.

Type: number

Range: 1-7

old-text

Description: This command allows you to modify the title text of the field in which users will enter their current password.

Type: string

Format: string-rlx

change-password.background

Specification
Type object

bgcolor

Description: This variable allows you specify the new color of the background image.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: bgcolor and bgfile are mutually exclusive

bgcolor-name

Description: This command allows you to modify the color of the background image. You can specify one of the following colors:
Aqua, Black, Blue, Fuchsia, Gray, Green Lime, Maroon, Navy Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: bgcolor-name and bgcolor-value are mutually exclusive

bgcolor-value

Description: This command allows you to specify a custom 6-digit HEX color value, for example, color #228B22.

Type: string

Mutual Exclusion: bgcolor-value and bgcolor-name are mutually exclusive

bgfile

Description: This command allows you to modify the background image file.

Type: string

Format: string-rlx

Mutual Exclusion: bgfile and bgcolor are mutually exclusive

bgstyle

Description: This command allows you to modify the style of the background image file. You can modify the following styles:
Tile, stretch and fit.

Type: string

Supported Values: tile, stretch, fit

change-password.cfm-pwd-cfg

Specification
Type object

cfm-color

Description: This variable allows you to specify the new color of the title text of the field in which users re-enter a new password for confirmation.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cfm-color-name

Description: This command allows you to modify the color of the title text of the field in which users re-enter a new password for confirmation. You can specify one of the following colors:
Aqua, Black, Blue, Fuchsia, Gray, Green Lime, Maroon, Navy Olive, Orange, Purple, Red, Silver, Teal, White and Yellow.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: cfm-color-name and cfm-color-value are mutually exclusive

cfm-color-value

Description: This command allows you to specify a 6-digit HEX color value, for example, color #228B22.

Type: string

Mutual Exclusion: cfm-color-value and cfm-color-name are mutually exclusive

cfm-face

Description: This command allows you to modify the font of the title text of the field in which users re-enter a new password for confirmation. You can use one of the following predefined fonts:
Arial, Courier New, Georgia, Time New Roman and Verdana.

Type: string

Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana

Mutual Exclusion: cfm-face and cfm-font-custom are mutually exclusive

cfm-font

Description: This variable allows you to specify a new font for the title text of the field in which users re-enter a new password for confirmation.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

cfm-font-custom

Description: This command allows you to specify a custom font, for example, Tahoma.

Type: string

Format: string-rlx

Mutual Exclusion: cfm-font-custom and cfm-face are mutually exclusive

cfm-size

Description: This variable allows you to specify the new size of the title text of the field in which users re-enter a new password. You can specify a font size between 1 and 7.

Type: number

Range: 1-7

cfm-text

Description: This command allows you to modify the title text of the field in which users re-enter a new password for confirmation.

Type: string

Format: string-rlx

confirm-password

Description: This variable allows you to specify the new password variable name.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

change-password.username-cfg

Specification
Type object

user-color

Description: This variable allows you to specify the new color of the user name that the user will enter.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user-color-name

Description: This command allows you to modify the color of the user name that the user will enter.

Type: string

Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow

Mutual Exclusion: user-color-name and user-color-value are mutually exclusive

user-color-value

Description: This command allows you to specify a 6-digit HEX color value, for example, color #228B22.

Type: string

Mutual Exclusion: user-color-value and user-color-name are mutually exclusive

user-face

Description: This command allows you to modify the font of the user name that the user will enter. You can use one of the following predefined fonts:

Type: string

Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana

Mutual Exclusion: user-face and user-font-custom are mutually exclusive

user-font

Description: This variable allows you to specify a new font for the user name that the user will enter.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

user-font-custom

Description: This command allows you to use a custom font, for example, Tahoma.

Type: string

Format: string-rlx

Mutual Exclusion: user-font-custom and user-face are mutually exclusive

user-size

Description: This variable allows you to specify the new size of the user name that the user will enter. You can specify a font size between 1 and 7.

Type: number

Range: 1-7

user-text

Description: This command allows you to modify the text for the user name that you use to log in to the Change Password page.

Type: string

Format: string-rlx

username

Description: This variable allows you to change how the Change Password Page text, font, font size and font color are displayed.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0