{ "id":"/axapi/v3/aam/authentication/portal/{name}", "type":"object", "node-type":"list", "title":"portal", "partition-visibility":"shared", "description":"Authentication portal configuration", "properties":{ "name":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'default-portal': Default portal configuration; ", "enum":[ "default-portal" ], "optional":false }, "logo-cfg":{ "type":"object", "properties":{ "logo":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify logo image filename" }, "width":{ "type":"number", "format":"number", "minimum":50, "maximum":400, "default":134, "partition-visibility":"shared", "description":"Specify logo image width (Default: 134)" }, "height":{ "type":"number", "format":"number", "minimum":50, "maximum":400, "default":71, "partition-visibility":"shared", "description":"Specify logo image height (Default: 71)" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "user-tag":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Customized tag", "optional":true }, "logon":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/portal/{name}/logon", "properties":{ "background":{ "type":"object", "properties":{ "bgfile":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not-list":[ "bgcolor-name", "bgcolor-value" ], "description":"Specify background image filename" }, "bgstyle":{ "type":"string", "format":"enum", "default":"tile", "partition-visibility":"shared", "description":"'tile': Tile; 'stretch': Stretch; 'fit': Fit; ", "enum":[ "tile", "stretch", "fit" ] }, "bgcolor-name":{ "type":"string", "format":"enum", "default":"white", "partition-visibility":"shared", "not-list":[ "bgfile", "bgcolor-value" ], "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "bgcolor-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not-list":[ "bgfile", "bgcolor-name" ], "description":"Specify 6-digit HEX color value" } } }, "fail-msg-cfg":{ "type":"object", "properties":{ "fail-msg":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure login failure message in default logon page" }, "fail-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify login failure message (Default: Invalid username or password. Please try again.)" }, "fail-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "fail-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"fail-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "fail-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"fail-face", "description":"Specify custom font" }, "fail-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":5, "partition-visibility":"shared", "description":"Specify font size (Default: 5)" }, "fail-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: red)" }, "fail-color-name":{ "type":"string", "format":"enum", "default":"red", "partition-visibility":"shared", "not":"fail-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "fail-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"fail-color-name", "description":"Specify 6-digit HEX color value" }, "authz-fail-msg":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "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.))" } } }, "action-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify form action URL in default logon page (Default: /logon.fo)" }, "username-cfg":{ "type":"object", "properties":{ "username":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure username text in default logon page" }, "user-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify username text (Default: User Name)" }, "user-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "user-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"user-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "user-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"user-face", "description":"Specify custom font" }, "user-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":3, "partition-visibility":"shared", "description":"Specify font size (Default: 3)" }, "user-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: black)" }, "user-color-name":{ "type":"string", "format":"enum", "default":"black", "partition-visibility":"shared", "not":"user-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "user-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"user-color-name", "description":"Specify 6-digit HEX color value" } } }, "username-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify username variable name in default logon page (Default: user)" }, "password-cfg":{ "type":"object", "properties":{ "password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure password text in default logon page" }, "pass-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify password text (Default: Password)" }, "pass-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "pass-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"pass-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "pass-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"pass-face", "description":"Specify custom font" }, "pass-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":3, "partition-visibility":"shared", "description":"Specify font size (Default: 3)" }, "pass-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: black)" }, "pass-color-name":{ "type":"string", "format":"enum", "default":"black", "partition-visibility":"shared", "not":"pass-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "pass-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"pass-color-name", "description":"Specify 6-digit HEX color value" } } }, "password-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify password variable name in default logon page (Default: pwd)" }, "enable-passcode":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable passcode field in default logon page" }, "passcode-cfg":{ "type":"object", "properties":{ "passcode":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure passcode text in default logon page" }, "passcode-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify passcode text (Default: Passcode)" }, "passcode-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "passcode-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"passcode-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "passcode-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"passcode-face", "description":"Specify custom font" }, "passcode-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":3, "partition-visibility":"shared", "description":"Specify font size (Default: 3)" }, "passcode-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: black)" }, "passcode-color-name":{ "type":"string", "format":"enum", "default":"black", "partition-visibility":"shared", "not":"passcode-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "passcode-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"passcode-color-name", "description":"Specify 6-digit HEX color value" } } }, "passcode-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify passcode variable name in default logon page (Default: passcode)" }, "enable-CAPTCHA":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable CAPTCHA in deafult logon page" }, "captcha-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'reCAPTCHAv2-checkbox': Google reCAPTCHAv2 Checkbox; 'reCAPTCHAv2-invisible': Google reCAPTCHAv2 Invisible; 'reCAPTCHAv3': Google reCAPTCHAv3; ", "enum":[ "reCAPTCHAv2-checkbox", "reCAPTCHAv2-invisible", "reCAPTCHAv3" ] }, "site-key-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Site key string" }, "encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)" }, "reCAPTCHA-cfg":{ "type":"object", "properties":{ "reCAPTCHA-theme":{ "type":"string", "format":"enum", "default":"light", "partition-visibility":"shared", "description":"'light': light theme; 'dark': dark theme; ", "enum":[ "light", "dark" ] }, "reCAPTCHA-size":{ "type":"string", "format":"enum", "default":"normal", "partition-visibility":"shared", "description":"'normal': normal size; 'compact': compact size; ", "enum":[ "normal", "compact" ] }, "reCAPTCHA-badge":{ "type":"string", "format":"enum", "default":"bottom-right", "partition-visibility":"shared", "description":"'bottom-left': bottom left corner; 'bottom-right': bottom right corner; ", "enum":[ "bottom-left", "bottom-right" ] }, "reCAPTCHA-action":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "default":"A10_DEFAULT_LOGON", "partition-visibility":"shared", "description":"Specify reCAPTCHA action (Specify action string, only accept alphanumeric, underscore, and slash (Default: A10_DEFAULT_LOGON))" } } }, "submit-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify submit button text in default logon page (Default: Log In)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "change-password":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/portal/{name}/change-password", "properties":{ "background":{ "type":"object", "properties":{ "bgfile":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not-list":[ "bgcolor-name", "bgcolor-value" ], "description":"Specify background image filename" }, "bgstyle":{ "type":"string", "format":"enum", "default":"tile", "partition-visibility":"shared", "description":"'tile': Tile; 'stretch': Stretch; 'fit': Fit; ", "enum":[ "tile", "stretch", "fit" ] }, "bgcolor-name":{ "type":"string", "format":"enum", "default":"white", "partition-visibility":"shared", "not-list":[ "bgfile", "bgcolor-value" ], "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "bgcolor-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not-list":[ "bgfile", "bgcolor-name" ], "description":"Specify 6-digit HEX color value" } } }, "title-cfg":{ "type":"object", "properties":{ "title":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure title in default change password page" }, "title-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify title (Default: Please Change Your Password)" }, "title-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "title-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"title-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "title-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"title-face", "description":"Specify custom font" }, "title-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":5, "partition-visibility":"shared", "description":"Specify font size (Default: 5)" }, "title-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: black)" }, "title-color-name":{ "type":"string", "format":"enum", "default":"black", "partition-visibility":"shared", "not":"title-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "title-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"title-color-name", "description":"Specify 6-digit HEX color value" } } }, "action-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify form action URL in default change password page (Default: /change.fo)" }, "username-cfg":{ "type":"object", "properties":{ "username":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure username text in default change password page" }, "user-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify username text (Default: Username)" }, "user-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "user-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"user-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "user-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"user-face", "description":"Specify custom font" }, "user-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":3, "partition-visibility":"shared", "description":"Specify font size (Default: 3)" }, "user-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: black)" }, "user-color-name":{ "type":"string", "format":"enum", "default":"black", "partition-visibility":"shared", "not":"user-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "user-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"user-color-name", "description":"Specify 6-digit HEX color value" } } }, "username-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify username variable name in default change password page (Default: cp_usr)" }, "old-pwd-cfg":{ "type":"object", "properties":{ "old-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure old password text in default change password page" }, "old-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify old password text (Default: Old Password)" }, "old-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "old-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"old-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "old-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"old-face", "description":"Specify custom font" }, "old-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":3, "partition-visibility":"shared", "description":"Specify font size (Default: 3)" }, "old-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: black)" }, "old-color-name":{ "type":"string", "format":"enum", "default":"black", "partition-visibility":"shared", "not":"old-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "old-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"old-color-name", "description":"Specify 6-digit HEX color value" } } }, "old-password-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify old password variable name in default change password page (Default: cp_old_pwd)" }, "new-pwd-cfg":{ "type":"object", "properties":{ "new-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure new password text in default change password page" }, "new-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify new password text (Default: New Password)" }, "new-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "new-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"new-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "new-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"new-face", "description":"Specify custom font" }, "new-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":3, "partition-visibility":"shared", "description":"Specify font size (Default: 3)" }, "new-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: black)" }, "new-color-name":{ "type":"string", "format":"enum", "default":"black", "partition-visibility":"shared", "not":"new-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "new-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"new-color-name", "description":"Specify 6-digit HEX color value" } } }, "new-password-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify new password variable name in default change password page (Default: cp_new_pwd)" }, "cfm-pwd-cfg":{ "type":"object", "properties":{ "confirm-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure confirm password text in default change password page" }, "cfm-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify confirm password text (Default: Confirm New Password)" }, "cfm-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "cfm-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"cfm-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "cfm-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"cfm-face", "description":"Specify custom font" }, "cfm-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":3, "partition-visibility":"shared", "description":"Specify font size (Default: 3)" }, "cfm-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: black)" }, "cfm-color-name":{ "type":"string", "format":"enum", "default":"black", "partition-visibility":"shared", "not":"cfm-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "cfm-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"cfm-color-name", "description":"Specify 6-digit HEX color value" } } }, "confirm-password-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify confirm password variable name in default change password page (Default: cp_cfm_pwd)" }, "submit-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify submit button text in default change password page (Default: Submit)" }, "reset-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify reset button text in default change password page (Default: Reset)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "notify-change-password":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/portal/{name}/notify-change-password", "properties":{ "background":{ "type":"object", "properties":{ "bgfile":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not-list":[ "bgcolor-name", "bgcolor-value" ], "description":"Specify background image filename" }, "bgstyle":{ "type":"string", "format":"enum", "default":"tile", "partition-visibility":"shared", "description":"'tile': Tile; 'stretch': Stretch; 'fit': Fit; ", "enum":[ "tile", "stretch", "fit" ] }, "bgcolor-name":{ "type":"string", "format":"enum", "default":"white", "partition-visibility":"shared", "not-list":[ "bgfile", "bgcolor-value" ], "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "bgcolor-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not-list":[ "bgfile", "bgcolor-name" ], "description":"Specify 6-digit HEX color value" } } }, "continue-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify continue action URL in default change password notification page (Default: /continue.fo)" }, "change-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify change password action URL in default change password notification page (Default: /notify_change.fo)" }, "username-cfg":{ "type":"object", "properties":{ "username":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure username text in default change password notification page" }, "user-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify username text (Default: Username)" }, "user-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "user-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"user-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "user-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"user-face", "description":"Specify custom font" }, "user-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":3, "partition-visibility":"shared", "description":"Specify font size (Default: 3)" }, "user-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: black)" }, "user-color-name":{ "type":"string", "format":"enum", "default":"black", "partition-visibility":"shared", "not":"user-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "user-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"user-color-name", "description":"Specify 6-digit HEX color value" } } }, "username-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify username variable name in default change password notification page (Default: cp_usr)" }, "old-pwd-cfg":{ "type":"object", "properties":{ "old-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure old password text in default change password notification page" }, "old-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify old password text (Default: Old Password)" }, "old-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "old-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"old-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "old-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"old-face", "description":"Specify custom font" }, "old-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":3, "partition-visibility":"shared", "description":"Specify font size (Default: 3)" }, "old-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: black)" }, "old-color-name":{ "type":"string", "format":"enum", "default":"black", "partition-visibility":"shared", "not":"old-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "old-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"old-color-name", "description":"Specify 6-digit HEX color value" } } }, "old-password-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify old password variable name in default change password notification page (Default: cp_old_pwd)" }, "new-pwd-cfg":{ "type":"object", "properties":{ "new-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure new password text in default change password notification page" }, "new-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify new password text (Default: New Password)" }, "new-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "new-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"new-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "new-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"new-face", "description":"Specify custom font" }, "new-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":3, "partition-visibility":"shared", "description":"Specify font size (Default: 3)" }, "new-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: black)" }, "new-color-name":{ "type":"string", "format":"enum", "default":"black", "partition-visibility":"shared", "not":"new-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "new-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"new-color-name", "description":"Specify 6-digit HEX color value" } } }, "new-password-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify new password variable name in default change password notification page (Default: cp_new_pwd)" }, "cfm-pwd-cfg":{ "type":"object", "properties":{ "confirm-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure confirm password text in default change password notification page" }, "cfm-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify confirm password text (Default: Confirm New Password)" }, "cfm-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "cfm-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"cfm-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "cfm-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"cfm-face", "description":"Specify custom font" }, "cfm-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":3, "partition-visibility":"shared", "description":"Specify font size (Default: 3)" }, "cfm-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: black)" }, "cfm-color-name":{ "type":"string", "format":"enum", "default":"black", "partition-visibility":"shared", "not":"cfm-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "cfm-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"cfm-color-name", "description":"Specify 6-digit HEX color value" } } }, "confirm-password-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify confirm password variable name in default change password notification page (Default: cp_cfm_pwd)" }, "change-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify change button text in default change password notification page (Default: Change)" }, "continue-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify continue button text in default change password notification page (Default: Continue)" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "logon-fail":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/portal/{name}/logon-fail", "properties":{ "background":{ "type":"object", "properties":{ "bgfile":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not-list":[ "bgcolor-name", "bgcolor-value" ], "description":"Specify background image filename" }, "bgstyle":{ "type":"string", "format":"enum", "default":"tile", "partition-visibility":"shared", "description":"'tile': Tile; 'stretch': Stretch; 'fit': Fit; ", "enum":[ "tile", "stretch", "fit" ] }, "bgcolor-name":{ "type":"string", "format":"enum", "default":"white", "partition-visibility":"shared", "not-list":[ "bgfile", "bgcolor-value" ], "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "bgcolor-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not-list":[ "bgfile", "bgcolor-name" ], "description":"Specify 6-digit HEX color value" } } }, "title-cfg":{ "type":"object", "properties":{ "title":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure title in default logon fail page" }, "title-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify title (Default: Try Too Many Times)" }, "title-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "title-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"title-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "title-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"title-face", "description":"Specify custom font" }, "title-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":5, "partition-visibility":"shared", "description":"Specify font size (Default: 5)" }, "title-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: black)" }, "title-color-name":{ "type":"string", "format":"enum", "default":"black", "partition-visibility":"shared", "not":"title-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "title-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"title-color-name", "description":"Specify 6-digit HEX color value" } } }, "fail-msg-cfg":{ "type":"object", "properties":{ "fail-msg":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Configure logon failure message in default logon fail page" }, "fail-text":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify logon failure message (Default: Login Failed!!)" }, "fail-font":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Sepcify font (Default: Arial)" }, "fail-face":{ "type":"string", "format":"enum", "default":"Arial", "partition-visibility":"shared", "not":"fail-font-custom", "description":"'Arial': Arial; 'Courier_New': Courier New; 'Georgia': Georgia; 'Times_New_Roman': Times New Roman; 'Verdana': Verdana; ", "enum":[ "Arial", "Courier_New", "Georgia", "Times_New_Roman", "Verdana" ] }, "fail-font-custom":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"fail-face", "description":"Specify custom font" }, "fail-size":{ "type":"number", "format":"number", "minimum":1, "maximum":7, "default":3, "partition-visibility":"shared", "description":"Specify font size (Default: 3)" }, "fail-color":{ "type":"number", "format":"flag", "default":1, "partition-visibility":"shared", "description":"Specify font color (Default: black)" }, "fail-color-name":{ "type":"string", "format":"enum", "default":"black", "partition-visibility":"shared", "not":"fail-color-value", "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; ", "enum":[ "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "orange", "purple", "red", "silver", "teal", "white", "yellow" ] }, "fail-color-value":{ "type":"string", "format":"string", "minLength":6, "maxLength":6, "partition-visibility":"shared", "not":"fail-color-name", "description":"Specify 6-digit HEX color value" } } }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } }, "object-keys":[ "name" ], "required":[ "name" ] }