.. _aam_authentication_portal: aam authentication portal ========================= Authentication portal configuration portal Specification -------------------- ===================================== ========================================================================= **Parameter** **Value** ===================================== ========================================================================= **Type** *Collection* **Object Key(s)** *name* **Collection Name** :ref:`45_portal_list` **Collection URI** /axapi/v3/aam/authentication/portal **Element Name** portal **Element URI** /axapi/v3/aam/authentication/portal/{name} **Element Attributes** portal_attributes **Partition Visibility** shared **Schema** :download:`portal schema ` ===================================== ========================================================================= **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/aam/authentication/portal .. raw:: html :ref:`45_portal_attributes` .. raw:: html
Create List .. raw:: html POST .. raw:: html /axapi/v3/aam/authentication/portal .. raw:: html :ref:`45_portal_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/aam/authentication/portal/{name} .. raw:: html :ref:`45_portal_attributes` .. raw:: html
Get List .. raw:: html GET .. raw:: html /axapi/v3/aam/authentication/portal .. raw:: html :ref:`45_portal_list` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/aam/authentication/portal/{name} .. raw:: html :ref:`45_portal_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/aam/authentication/portal/{name} .. raw:: html :ref:`45_portal_attributes` .. raw:: html
Replace List .. raw:: html PUT .. raw:: html /axapi/v3/aam/authentication/portal .. raw:: html :ref:`45_portal_list` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/aam/authentication/portal/{name} .. raw:: html :ref:`45_portal_attributes` .. raw:: html
.. _45_portal_list: portal-list ----------- portal-list is **JSON List** of :ref:`45_portal_attributes` portal-list : [ { :ref:`45_portal_attributes` }, { :ref:`45_portal_attributes` }, ... ] .. _45_portal_attributes: portal attributes ----------------- **change-password** **Description:** change-password is a **JSON Block**. Please see below for :ref:`45_change-password` **Type:** Object **Reference Object:** :doc:`/axapi/v3/aam/authentication/portal/{name}/change-password ` **logo-cfg** **Description:** logo-cfg is a **JSON Block**. Please see below for :ref:`45_logo-cfg` **Type:** Object **logon** **Description:** logon is a **JSON Block**. Please see below for :ref:`45_logon` **Type:** Object **Reference Object:** :doc:`/axapi/v3/aam/authentication/portal/{name}/logon ` **logon-fail** **Description:** logon-fail is a **JSON Block**. Please see below for :ref:`45_logon-fail` **Type:** Object **Reference Object:** :doc:`/axapi/v3/aam/authentication/portal/{name}/logon-fail ` **name** **Description** 'default-portal': Default portal configuration; **Type:** string **Supported Values:** default-portal **notify-change-password** **Description:** notify-change-password is a **JSON Block**. Please see below for :ref:`45_notify-change-password` **Type:** Object **Reference Object:** :doc:`/axapi/v3/aam/authentication/portal/{name}/notify-change-password ` **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _45_logon-fail: logon-fail ^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **background** **Description:** background is a **JSON Block**. Please see below for :ref:`45_logon-fail_background` **Type:** Object **fail-msg-cfg** **Description:** fail-msg-cfg is a **JSON Block**. Please see below for :ref:`45_logon-fail_fail-msg-cfg` **Type:** Object **title-cfg** **Description:** title-cfg is a **JSON Block**. Please see below for :ref:`45_logon-fail_title-cfg` **Type:** Object **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _45_logon-fail_fail-msg-cfg: logon-fail_fail-msg-cfg ^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **fail-color** **Description** Specify font color (Default: black) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **fail-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 **Default:** black **Mutual Exclusion:** fail-color-name and fail-color-value are mutually exclusive **fail-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** fail-color-value and fail-color-name are mutually exclusive **fail-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 **Default:** Arial **Mutual Exclusion:** fail-face and fail-font-custom are mutually exclusive **fail-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **fail-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** fail-font-custom and fail-face are mutually exclusive **fail-msg** **Description** Configure logon failure message in default logon fail page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fail-size** **Description** Specify font size (Default: 3) **Type:** number **Range:** 1-7 **Default:** 3 **fail-text** **Description** Specify logon failure message (Default: Login Failed!!) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _45_logon-fail_title-cfg: logon-fail_title-cfg ^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **title** **Description** Configure title in default logon fail page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **title-color** **Description** Specify font color (Default: black) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **title-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 **Default:** black **Mutual Exclusion:** title-color-name and title-color-value are mutually exclusive **title-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** title-color-value and title-color-name are mutually exclusive **title-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 **Default:** Arial **Mutual Exclusion:** title-face and title-font-custom are mutually exclusive **title-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **title-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** title-font-custom and title-face are mutually exclusive **title-size** **Description** Specify font size (Default: 5) **Type:** number **Range:** 1-7 **Default:** 5 **title-text** **Description** Specify title (Default: Try Too Many Times) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _45_logon-fail_background: logon-fail_background ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bgcolor-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 **Default:** white **Mutual Exclusion:** bgcolor-name, bgfile, and bgcolor-value are mutually exclusive **bgcolor-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** bgcolor-value, bgfile, and bgcolor-name are mutually exclusive **bgfile** **Description** Specify background image filename **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** bgfile, bgcolor-name, and bgcolor-value are mutually exclusive **bgstyle** **Description** 'tile': Tile; 'stretch': Stretch; 'fit': Fit; **Type:** string **Supported Values:** tile, stretch, fit **Default:** tile .. _45_logo-cfg: logo-cfg ^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **height** **Description** Specify logo image height (Default: 71) **Type:** number **Range:** 50-400 **Default:** 71 **logo** **Description** Specify logo image filename **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **width** **Description** Specify logo image width (Default: 134) **Type:** number **Range:** 50-400 **Default:** 134 .. _45_notify-change-password: notify-change-password ^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **background** **Description:** background is a **JSON Block**. Please see below for :ref:`45_notify-change-password_background` **Type:** Object **cfm-pwd-cfg** **Description:** cfm-pwd-cfg is a **JSON Block**. Please see below for :ref:`45_notify-change-password_cfm-pwd-cfg` **Type:** Object **change-text** **Description** Specify change button text in default change password notification page (Default: Change) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **change-url** **Description** Specify change password action URL in default change password notification page (Default: /notify_change.fo) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **confirm-password-var** **Description** Specify confirm password variable name in default change password notification page (Default: cp_cfm_pwd) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **continue-text** **Description** Specify continue button text in default change password notification page (Default: Continue) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **continue-url** **Description** Specify continue action URL in default change password notification page (Default: /continue.fo) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **new-password-var** **Description** Specify new password variable name in default change password notification page (Default: cp_new_pwd) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **new-pwd-cfg** **Description:** new-pwd-cfg is a **JSON Block**. Please see below for :ref:`45_notify-change-password_new-pwd-cfg` **Type:** Object **old-password-var** **Description** Specify old password variable name in default change password notification page (Default: cp_old_pwd) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **old-pwd-cfg** **Description:** old-pwd-cfg is a **JSON Block**. Please see below for :ref:`45_notify-change-password_old-pwd-cfg` **Type:** Object **username-cfg** **Description:** username-cfg is a **JSON Block**. Please see below for :ref:`45_notify-change-password_username-cfg` **Type:** Object **username-var** **Description** Specify username variable name in default change password notification page (Default: cp_usr) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _45_notify-change-password_new-pwd-cfg: notify-change-password_new-pwd-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **new-color** **Description** Specify font color (Default: black) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **new-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 **Default:** black **Mutual Exclusion:** new-color-name and new-color-value are mutually exclusive **new-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** new-color-value and new-color-name are mutually exclusive **new-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 **Default:** Arial **Mutual Exclusion:** new-face and new-font-custom are mutually exclusive **new-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **new-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** new-font-custom and new-face are mutually exclusive **new-password** **Description** Configure new password text in default change password notification page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **new-size** **Description** Specify font size (Default: 3) **Type:** number **Range:** 1-7 **Default:** 3 **new-text** **Description** Specify new password text (Default: New Password) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _45_notify-change-password_old-pwd-cfg: notify-change-password_old-pwd-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **old-color** **Description** Specify font color (Default: black) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **old-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 **Default:** black **Mutual Exclusion:** old-color-name and old-color-value are mutually exclusive **old-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** old-color-value and old-color-name are mutually exclusive **old-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 **Default:** Arial **Mutual Exclusion:** old-face and old-font-custom are mutually exclusive **old-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **old-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** old-font-custom and old-face are mutually exclusive **old-password** **Description** Configure old password text in default change password notification page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **old-size** **Description** Specify font size (Default: 3) **Type:** number **Range:** 1-7 **Default:** 3 **old-text** **Description** Specify old password text (Default: Old Password) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _45_notify-change-password_background: notify-change-password_background ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bgcolor-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 **Default:** white **Mutual Exclusion:** bgcolor-name, bgfile, and bgcolor-value are mutually exclusive **bgcolor-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** bgcolor-value, bgfile, and bgcolor-name are mutually exclusive **bgfile** **Description** Specify background image filename **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** bgfile, bgcolor-name, and bgcolor-value are mutually exclusive **bgstyle** **Description** 'tile': Tile; 'stretch': Stretch; 'fit': Fit; **Type:** string **Supported Values:** tile, stretch, fit **Default:** tile .. _45_notify-change-password_cfm-pwd-cfg: notify-change-password_cfm-pwd-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cfm-color** **Description** Specify font color (Default: black) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **cfm-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 **Default:** black **Mutual Exclusion:** cfm-color-name and cfm-color-value are mutually exclusive **cfm-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** cfm-color-value and cfm-color-name are mutually exclusive **cfm-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 **Default:** Arial **Mutual Exclusion:** cfm-face and cfm-font-custom are mutually exclusive **cfm-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **cfm-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** cfm-font-custom and cfm-face are mutually exclusive **cfm-size** **Description** Specify font size (Default: 3) **Type:** number **Range:** 1-7 **Default:** 3 **cfm-text** **Description** Specify confirm password text (Default: Confirm New Password) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **confirm-password** **Description** Configure confirm password text in default change password notification page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _45_notify-change-password_username-cfg: notify-change-password_username-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **user-color** **Description** Specify font color (Default: black) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **user-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 **Default:** black **Mutual Exclusion:** user-color-name and user-color-value are mutually exclusive **user-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** user-color-value and user-color-name are mutually exclusive **user-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 **Default:** Arial **Mutual Exclusion:** user-face and user-font-custom are mutually exclusive **user-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **user-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** user-font-custom and user-face are mutually exclusive **user-size** **Description** Specify font size (Default: 3) **Type:** number **Range:** 1-7 **Default:** 3 **user-text** **Description** Specify username text (Default: Username) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **username** **Description** Configure username text in default change password notification page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _45_logon: logon ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action-url** **Description** Specify form action URL in default logon page (Default: /logon.fo) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **background** **Description:** background is a **JSON Block**. Please see below for :ref:`45_logon_background` **Type:** Object **captcha-type** **Description** 'reCAPTCHAv2-checkbox': Google reCAPTCHAv2 Checkbox; 'reCAPTCHAv2-invisible': Google reCAPTCHAv2 Invisible; 'reCAPTCHAv3': Google reCAPTCHAv3; **Type:** string **Supported Values:** reCAPTCHAv2-checkbox, reCAPTCHAv2-invisible, reCAPTCHAv3 **enable-CAPTCHA** **Description** Enable CAPTCHA in deafult logon page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **enable-passcode** **Description** Enable passcode field in default logon page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **encrypted** **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string) **fail-msg-cfg** **Description:** fail-msg-cfg is a **JSON Block**. Please see below for :ref:`45_logon_fail-msg-cfg` **Type:** Object **passcode-cfg** **Description:** passcode-cfg is a **JSON Block**. Please see below for :ref:`45_logon_passcode-cfg` **Type:** Object **passcode-var** **Description** Specify passcode variable name in default logon page (Default: passcode) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **password-cfg** **Description:** password-cfg is a **JSON Block**. Please see below for :ref:`45_logon_password-cfg` **Type:** Object **password-var** **Description** Specify password variable name in default logon page (Default: pwd) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **reCAPTCHA-cfg** **Description:** reCAPTCHA-cfg is a **JSON Block**. Please see below for :ref:`45_logon_reCAPTCHA-cfg` **Type:** Object **site-key-string** **Description** Site key string **Type:** string **Format:** password **Maximum Length:** 127 characters **Maximum Length:** 1 characters **submit-text** **Description** Specify submit button text in default logon page (Default: Log In) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **username-cfg** **Description:** username-cfg is a **JSON Block**. Please see below for :ref:`45_logon_username-cfg` **Type:** Object **username-var** **Description** Specify username variable name in default logon page (Default: user) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _45_logon_passcode-cfg: logon_passcode-cfg ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 (Default: black) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **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 **Default:** black **Mutual Exclusion:** passcode-color-name and passcode-color-value are mutually exclusive **passcode-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **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 **Default:** Arial **Mutual Exclusion:** passcode-face and passcode-font-custom are mutually exclusive **passcode-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **passcode-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** passcode-font-custom and passcode-face are mutually exclusive **passcode-size** **Description** Specify font size (Default: 3) **Type:** number **Range:** 1-7 **Default:** 3 **passcode-text** **Description** Specify passcode text (Default: Passcode) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _45_logon_reCAPTCHA-cfg: logon_reCAPTCHA-cfg ^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **reCAPTCHA-action** **Description** Specify reCAPTCHA action (Specify action string, only accept alphanumeric, underscore, and slash (Default: A10_DEFAULT_LOGON)) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Default:** A10_DEFAULT_LOGON **reCAPTCHA-badge** **Description** 'bottom-left': bottom left corner; 'bottom-right': bottom right corner; **Type:** string **Supported Values:** bottom-left, bottom-right **Default:** bottom-right **reCAPTCHA-size** **Description** 'normal': normal size; 'compact': compact size; **Type:** string **Supported Values:** normal, compact **Default:** normal **reCAPTCHA-theme** **Description** 'light': light theme; 'dark': dark theme; **Type:** string **Supported Values:** light, dark **Default:** light .. _45_logon_background: logon_background ^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bgcolor-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 **Default:** white **Mutual Exclusion:** bgcolor-name, bgfile, and bgcolor-value are mutually exclusive **bgcolor-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** bgcolor-value, bgfile, and bgcolor-name are mutually exclusive **bgfile** **Description** Specify background image filename **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** bgfile, bgcolor-name, and bgcolor-value are mutually exclusive **bgstyle** **Description** 'tile': Tile; 'stretch': Stretch; 'fit': Fit; **Type:** string **Supported Values:** tile, stretch, fit **Default:** tile .. _45_logon_fail-msg-cfg: logon_fail-msg-cfg ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **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 **Maximum Length:** 63 characters **Maximum Length:** 1 characters **fail-color** **Description** Specify font color (Default: red) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **fail-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 **Default:** red **Mutual Exclusion:** fail-color-name and fail-color-value are mutually exclusive **fail-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** fail-color-value and fail-color-name are mutually exclusive **fail-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 **Default:** Arial **Mutual Exclusion:** fail-face and fail-font-custom are mutually exclusive **fail-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **fail-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** fail-font-custom and fail-face are mutually exclusive **fail-msg** **Description** Configure login failure message in default logon page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **fail-size** **Description** Specify font size (Default: 5) **Type:** number **Range:** 1-7 **Default:** 5 **fail-text** **Description** Specify login failure message (Default: Invalid username or password. Please try again.) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _45_logon_password-cfg: logon_password-cfg ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **pass-color** **Description** Specify font color (Default: black) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **pass-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 **Default:** black **Mutual Exclusion:** pass-color-name and pass-color-value are mutually exclusive **pass-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** pass-color-value and pass-color-name are mutually exclusive **pass-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 **Default:** Arial **Mutual Exclusion:** pass-face and pass-font-custom are mutually exclusive **pass-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **pass-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** pass-font-custom and pass-face are mutually exclusive **pass-size** **Description** Specify font size (Default: 3) **Type:** number **Range:** 1-7 **Default:** 3 **pass-text** **Description** Specify password text (Default: Password) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **password** **Description** Configure password text in default logon page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _45_logon_username-cfg: logon_username-cfg ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **user-color** **Description** Specify font color (Default: black) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **user-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 **Default:** black **Mutual Exclusion:** user-color-name and user-color-value are mutually exclusive **user-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** user-color-value and user-color-name are mutually exclusive **user-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 **Default:** Arial **Mutual Exclusion:** user-face and user-font-custom are mutually exclusive **user-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **user-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** user-font-custom and user-face are mutually exclusive **user-size** **Description** Specify font size (Default: 3) **Type:** number **Range:** 1-7 **Default:** 3 **user-text** **Description** Specify username text (Default: User Name) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **username** **Description** Configure username text in default logon page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _45_change-password: change-password ^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **action-url** **Description** Specify form action URL in default change password page (Default: /change.fo) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **background** **Description:** background is a **JSON Block**. Please see below for :ref:`45_change-password_background` **Type:** Object **cfm-pwd-cfg** **Description:** cfm-pwd-cfg is a **JSON Block**. Please see below for :ref:`45_change-password_cfm-pwd-cfg` **Type:** Object **confirm-password-var** **Description** Specify confirm password variable name in default change password page (Default: cp_cfm_pwd) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **new-password-var** **Description** Specify new password variable name in default change password page (Default: cp_new_pwd) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **new-pwd-cfg** **Description:** new-pwd-cfg is a **JSON Block**. Please see below for :ref:`45_change-password_new-pwd-cfg` **Type:** Object **old-password-var** **Description** Specify old password variable name in default change password page (Default: cp_old_pwd) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **old-pwd-cfg** **Description:** old-pwd-cfg is a **JSON Block**. Please see below for :ref:`45_change-password_old-pwd-cfg` **Type:** Object **reset-text** **Description** Specify reset button text in default change password page (Default: Reset) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **submit-text** **Description** Specify submit button text in default change password page (Default: Submit) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **title-cfg** **Description:** title-cfg is a **JSON Block**. Please see below for :ref:`45_change-password_title-cfg` **Type:** Object **username-cfg** **Description:** username-cfg is a **JSON Block**. Please see below for :ref:`45_change-password_username-cfg` **Type:** Object **username-var** **Description** Specify username variable name in default change password page (Default: cp_usr) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters .. _45_change-password_new-pwd-cfg: change-password_new-pwd-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **new-color** **Description** Specify font color (Default: black) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **new-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 **Default:** black **Mutual Exclusion:** new-color-name and new-color-value are mutually exclusive **new-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** new-color-value and new-color-name are mutually exclusive **new-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 **Default:** Arial **Mutual Exclusion:** new-face and new-font-custom are mutually exclusive **new-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **new-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** new-font-custom and new-face are mutually exclusive **new-password** **Description** Configure new password text in default change password page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **new-size** **Description** Specify font size (Default: 3) **Type:** number **Range:** 1-7 **Default:** 3 **new-text** **Description** Specify new password text (Default: New Password) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _45_change-password_title-cfg: change-password_title-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **title** **Description** Configure title in default change password page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **title-color** **Description** Specify font color (Default: black) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **title-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 **Default:** black **Mutual Exclusion:** title-color-name and title-color-value are mutually exclusive **title-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** title-color-value and title-color-name are mutually exclusive **title-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 **Default:** Arial **Mutual Exclusion:** title-face and title-font-custom are mutually exclusive **title-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **title-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** title-font-custom and title-face are mutually exclusive **title-size** **Description** Specify font size (Default: 5) **Type:** number **Range:** 1-7 **Default:** 5 **title-text** **Description** Specify title (Default: Please Change Your Password) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _45_change-password_old-pwd-cfg: change-password_old-pwd-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **old-color** **Description** Specify font color (Default: black) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **old-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 **Default:** black **Mutual Exclusion:** old-color-name and old-color-value are mutually exclusive **old-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** old-color-value and old-color-name are mutually exclusive **old-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 **Default:** Arial **Mutual Exclusion:** old-face and old-font-custom are mutually exclusive **old-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **old-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** old-font-custom and old-face are mutually exclusive **old-password** **Description** Configure old password text in default change password page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **old-size** **Description** Specify font size (Default: 3) **Type:** number **Range:** 1-7 **Default:** 3 **old-text** **Description** Specify old password text (Default: Old Password) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters .. _45_change-password_background: change-password_background ^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **bgcolor-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 **Default:** white **Mutual Exclusion:** bgcolor-name, bgfile, and bgcolor-value are mutually exclusive **bgcolor-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** bgcolor-value, bgfile, and bgcolor-name are mutually exclusive **bgfile** **Description** Specify background image filename **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** bgfile, bgcolor-name, and bgcolor-value are mutually exclusive **bgstyle** **Description** 'tile': Tile; 'stretch': Stretch; 'fit': Fit; **Type:** string **Supported Values:** tile, stretch, fit **Default:** tile .. _45_change-password_cfm-pwd-cfg: change-password_cfm-pwd-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **cfm-color** **Description** Specify font color (Default: black) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **cfm-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 **Default:** black **Mutual Exclusion:** cfm-color-name and cfm-color-value are mutually exclusive **cfm-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** cfm-color-value and cfm-color-name are mutually exclusive **cfm-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 **Default:** Arial **Mutual Exclusion:** cfm-face and cfm-font-custom are mutually exclusive **cfm-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **cfm-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** cfm-font-custom and cfm-face are mutually exclusive **cfm-size** **Description** Specify font size (Default: 3) **Type:** number **Range:** 1-7 **Default:** 3 **cfm-text** **Description** Specify confirm password text (Default: Confirm New Password) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **confirm-password** **Description** Configure confirm password text in default change password page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 .. _45_change-password_username-cfg: change-password_username-cfg ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **user-color** **Description** Specify font color (Default: black) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **user-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 **Default:** black **Mutual Exclusion:** user-color-name and user-color-value are mutually exclusive **user-color-value** **Description** Specify 6-digit HEX color value **Type:** string **Maximum Length:** 6 characters **Maximum Length:** 6 characters **Mutual Exclusion:** user-color-value and user-color-name are mutually exclusive **user-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 **Default:** Arial **Mutual Exclusion:** user-face and user-font-custom are mutually exclusive **user-font** **Description** Sepcify font (Default: Arial) **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 1 **user-font-custom** **Description** Specify custom font **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **Mutual Exclusion:** user-font-custom and user-face are mutually exclusive **user-size** **Description** Specify font size (Default: 3) **Type:** number **Range:** 1-7 **Default:** 3 **user-text** **Description** Specify username text (Default: Username) **Type:** string **Format:** string-rlx **Maximum Length:** 63 characters **Maximum Length:** 1 characters **username** **Description** Configure username text in default change password page **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0