{ "id":"/axapi/v3/aam/authentication", "type":"object", "node-type":"intermediate", "title":"authentication", "operation-not-allowed": ["PUT", "POST", "DELETE"], "partition-visibility":"shared", "auto-created-object":1, "description":"AAM authentication related configuration", "properties":{ "global":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/global", "properties":{ "max-auth-resp-size":{ "type":"number", "format":"number", "minimum":2048, "maximum":131072, "default":65536, "partition-visibility":"shared", "description":"Specify the max auth resp size in bytes(from authd to a10lb), default is 64KB" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'requests': Total Authentication Request; 'responses': Total Authentication Response; 'misses': Total Authentication Request Missed; 'ocsp-stapling-requests-to-a10authd': Total OCSP Stapling Request; 'ocsp-stapling-responses-from-a10authd': Total OCSP Stapling Response; 'opened-socket': Total AAM Socket Opened; 'open-socket-failed': Total AAM Open Socket Failed; 'connect': Total AAM Connection; 'connect-failed': Total AAM Connect Failed; 'created-timer': Total AAM Timer Created; 'create-timer-failed': Total AAM Timer Creation Failed; 'total-request': Total Request Received by A10 Auth Service; 'get-socket-option-failed': Total AAM Get Socket Option Failed; 'aflex-authz-succ': Total Authorization success number in aFleX; 'aflex-authz-fail': Total Authorization failure number in aFleX; 'authn-success': Total Authentication success number; 'authn-failure': Total Authentication failure number; 'authz-success': Total Authorization success number; 'authz-failure': Total Authorization failure number; 'active-session': Total Active Auth-Sessions; 'active-user': Total Active Users; 'dns-resolve-failed': Total AAM DNS resolve failed; 'domain-wlist-match': Total DOMAIN WHITELIST match number; 'domain-wlist-unmatch': Total DOMAIN WHITELIST unmatch number; 'auth_ctx_num': Total Auth Contexts; ", "enum":[ "all", "requests", "responses", "misses", "ocsp-stapling-requests-to-a10authd", "ocsp-stapling-responses-from-a10authd", "opened-socket", "open-socket-failed", "connect", "connect-failed", "created-timer", "create-timer-failed", "total-request", "get-socket-option-failed", "aflex-authz-succ", "aflex-authz-fail", "authn-success", "authn-failure", "authz-success", "authz-failure", "active-session", "active-user", "dns-resolve-failed", "domain-wlist-match", "domain-wlist-unmatch", "auth_ctx_num" ] } } } ] } } }, "session":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/session", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "session-attr":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/session-attr", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "password-retry":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/password-retry", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "jwks":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/jwks", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "portal-list":{ "type":"array", "minItems":1, "items":{ "type":"portal" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/portal/{name}", "array":[ { "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" } } } }, "required":[ "name" ] } ] }, "file":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/file", "properties":{ "portal":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/file/portal", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "portal-image":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/file/portal-image", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } } } }, "logon":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/logon", "properties":{ "http-authenticate":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/logon/http-authenticate", "properties":{ "instance-list":{ "type":"array", "minItems":1, "items":{ "type":"instance" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/logon/http-authenticate/instance/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify HTTP-Authenticate logon name", "optional":false }, "auth-method":{ "type":"object", "properties":{ "basic":{ "type":"object", "properties":{ "basic-realm":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify realm for basic logon" }, "challenge-response-form":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify challenge-response form for RSA-RADIUS authentication" }, "challenge-page":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"new-pin-page", "description":"Specify challenge page name for RSA-RADIUS" }, "challenge-variable":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify challenge variable name" }, "new-pin-page":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"challenge-page", "description":"Specify new PIN page name for RSA-RADIUS" }, "next-token-page":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify next-token page name for RSA-RADIUS" }, "new-pin-variable":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify new PIN variable name" }, "next-token-variable":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify next-token variable name" }, "basic-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable Basic logon" } } }, "ntlm":{ "type":"object", "properties":{ "ntlm-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable NTLM logon" } } }, "negotiate":{ "type":"object", "properties":{ "negotiate-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable SPENGO logon" } } } } }, "hsts-timeout":{ "type":"number", "format":"number", "minimum":0, "maximum":315360000, "partition-visibility":"shared", "description":"Set HSTS policy expired timeout in seconds, 0 means to disable HSTS policy", "optional":true }, "retry":{ "type":"number", "format":"number", "minimum":1, "maximum":32, "default":3, "partition-visibility":"shared", "description":"Maximum number of consecutive failed logon attempts (default 3)", "optional":true }, "account-lock":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Lock the account when the failed logon attempts is exceeded", "optional":true }, "duration":{ "type":"number", "format":"number", "minimum":1, "maximum":86400, "default":1800, "partition-visibility":"shared", "description":"The time an account remains locked in seconds (default 1800)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'spn_krb_request': SPN Kerberos Request; 'spn_krb_success': SPN Kerberos Success; 'spn_krb_faiure': SPN Kerberos Failure; ", "enum":[ "all", "spn_krb_request", "spn_krb_success", "spn_krb_faiure" ] } } } ] }, "packet-capture-template":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/visibility/packet-capture/object-templates/aam-auth-logon-http-ins-tmpl", "description":"Name of the packet capture template to be bind with this object", "optional":true } }, "required":[ "name" ] } ] } } }, "form-based-list":{ "type":"array", "minItems":1, "items":{ "type":"form-based" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/logon/form-based/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify form-based authentication logon name", "optional":false }, "portal":{ "type":"object", "properties":{ "default-portal":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"portal-name", "description":"Use default portal" }, "portal-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"default-portal", "description":"Specify portal name" }, "logon":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify logon page name" }, "failpage":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify logon fail page name (portal fail page name)" }, "changepasswordpage":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify change password page name" }, "notifychangepasswordpage":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify change password notification page name" }, "challenge-page":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not-list":[ "new-pin-page", "next-token-page" ], "description":"Specify challenge page name for RSA-RADIUS" }, "new-pin-page":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"challenge-page", "description":"Specify new PIN page name for RSA-RADIUS" }, "next-token-page":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"challenge-page", "description":"Specify next token page name for RSA-RADIUS" } } }, "csp-support":{ "type":"object", "properties":{ "none":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not-list":[ "self", "specificURI" ], "description":"Set CSP frame-ancestors to none (also X-Frame-Options deny)" }, "self":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"none", "description":"Set CSP frame-ancestors to self (also X-Frame-Options same-origin)" }, "specificURI":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "not":"none", "description":"Set customized CSP frame-ancestors (maximum 2 URIs can be set)" }, "optional-second-URI":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Set optional second customized CSP URI" } } }, "hsts-timeout":{ "type":"number", "format":"number", "minimum":0, "maximum":315360000, "partition-visibility":"shared", "description":"Set HSTS policy expired timeout in seconds, 0 means to disable HSTS policy", "optional":true }, "logon-page-cfg":{ "type":"object", "properties":{ "action-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify form submission action url" }, "username-variable":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify username variable name in form submission" }, "password-variable":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify password variable name in form submission" }, "passcode-variable":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify passcode variable name in form submission" }, "captcha-variable":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify captcha variable name in form submission" }, "login-failure-message":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify login failure message shown in logon page (Specify error string, default is \"Invalid username or password. Please try again.\")" }, "authz-failure-message":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify authorization failure message shown in logon page (Specify error string, default is \"Authorization failed. Please contact your system administrator.\")" }, "disable-change-password-link":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Don't display change password link on logon page forcibly even backend authentication server supports it (LDAP or Kerberos)" } } }, "cp-page-cfg":{ "type":"object", "properties":{ "changepassword-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify changepassword form submission action url (changepassword action url)" }, "cp-user-enum":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'changepassword-username-variable': Specify username variable name in form submission; ", "enum":[ "changepassword-username-variable" ] }, "cp-user-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify username variable name" }, "cp-old-pwd-enum":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'changepassword-old-password-variable': Specify old password variable name in form submission; ", "enum":[ "changepassword-old-password-variable" ] }, "cp-old-pwd-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify old password variable name" }, "cp-new-pwd-enum":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'changepassword-new-password-variable': Specify new password variable name in form submission; ", "enum":[ "changepassword-new-password-variable" ] }, "cp-new-pwd-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify new password variable name" }, "cp-cfm-pwd-enum":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'changepassword-password-confirm-variable': Specify password confirm variable name in form submission; ", "enum":[ "changepassword-password-confirm-variable" ] }, "cp-cfm-pwd-var":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify password confirm variable name" } } }, "notify-cp-page-cfg":{ "type":"object", "properties":{ "notifychangepassword-change-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify change password action url for notifychangepassword form" }, "notifychangepassword-continue-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify continue action url for notifychangepassword form" } } }, "challenge-variable":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify challenge variable name in form submission", "optional":true }, "new-pin-variable":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify new-pin variable name in form submission", "optional":true }, "next-token-variable":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify next-token variable name in form submission", "optional":true }, "retry":{ "type":"number", "format":"number", "minimum":1, "maximum":32, "default":3, "partition-visibility":"shared", "description":"Maximum number of consecutive failed logon attempts (default 3)", "optional":true }, "account-lock":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Lock the account when the failed logon attempts is exceeded", "optional":true }, "duration":{ "type":"number", "format":"number", "minimum":1, "maximum":86400, "default":1800, "partition-visibility":"shared", "description":"The time an account remains locked in seconds (default 1800)", "optional":true }, "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 } }, "required":[ "name" ] } ] } } }, "server":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/server", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "ldap":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/server/ldap", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'admin-bind-success': Total Admin Bind Success; 'admin-bind-failure': Total Admin Bind Failure; 'bind-success': Total User Bind Success; 'bind-failure': Total User Bind Failure; 'search-success': Total Search Success; 'search-failure': Total Search Failure; 'authorize-success': Total Authorization Success; 'authorize-failure': Total Authorization Failure; 'timeout-error': Total Timeout; 'other-error': Total Other Error; 'request': Total Request; 'request-normal': Total Normal Request; 'request-dropped': Total Dropped Request; 'response-success': Total Success Response; 'response-failure': Total Failure Response; 'response-error': Total Error Response; 'response-timeout': Total Timeout Response; 'response-other': Total Other Response; 'job-start-error': Total Job Start Error; 'polling-control-error': Total Polling Control Error; 'ssl-session-created': TLS/SSL Session Created; 'ssl-session-failure': TLS/SSL Session Failure; 'ldaps-idle-conn-num': LDAPS Idle Connection Number; 'ldaps-inuse-conn-num': LDAPS In-use Connection Number; 'pw-expiry': Total Password expiry; 'pw-change-success': Total password change success; 'pw-change-failure': Total password change failure; ", "enum":[ "all", "admin-bind-success", "admin-bind-failure", "bind-success", "bind-failure", "search-success", "search-failure", "authorize-success", "authorize-failure", "timeout-error", "other-error", "request", "request-normal", "request-dropped", "response-success", "response-failure", "response-error", "response-timeout", "response-other", "job-start-error", "polling-control-error", "ssl-session-created", "ssl-session-failure", "ldaps-idle-conn-num", "ldaps-inuse-conn-num", "pw-expiry", "pw-change-success", "pw-change-failure" ] } } } ] }, "instance-list":{ "type":"array", "minItems":1, "items":{ "type":"instance" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/server/ldap/instance/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify LDAP authentication server name", "optional":false }, "host":{ "type":"object", "properties":{ "hostip":{ "type":"string", "format":"host", "minLength":1, "maxLength":31, "partition-visibility":"shared", "not":"hostipv6", "description":"Server's hostname(Length 1-31) or IP address" }, "hostipv6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not":"hostip", "description":"Server's IPV6 address" } } }, "base":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify the LDAP server's search base", "optional":true }, "port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":389, "partition-visibility":"shared", "description":"Specify the LDAP server's authentication port, default is 389", "optional":true }, "port-hm":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "not":"port-hm-disable", "description":"Check port's health status", "optional":true }, "port-hm-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"port-hm", "description":"Disable configured port health check configuration", "optional":true }, "pwdmaxage":{ "type":"number", "format":"number", "minimum":0, "maximum":4294967295, "default":0, "partition-visibility":"shared", "description":"Specify the LDAP server's default password expiration time (in seconds) (The LDAP server's default password expiration time (in seconds), default is 0 (no expiration))", "optional":true }, "admin-dn":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"The LDAP server's admin DN", "optional":true }, "admin-secret":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify the LDAP server's admin secret password", "optional":true }, "secret-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"secret password", "optional":true }, "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)", "optional":true }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "default":10, "partition-visibility":"shared", "description":"Specify timout for LDAP, default is 10 seconds (The timeout, default is 10 seconds)", "optional":true }, "dn-attribute":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "default":"cn", "partition-visibility":"shared", "description":"Specify Distinguished Name attribute, default is CN", "optional":true }, "default-domain":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify default domain for LDAP", "optional":true }, "bind-with-dn":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enforce using DN for LDAP binding(All user input name will be used to create DN)", "optional":true }, "derive-bind-dn":{ "type":"object", "properties":{ "username-attr":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Specify attribute name of username" } } }, "health-check":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"health-check-disable", "description":"Check server's health status", "optional":true }, "health-check-string":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "description":"Health monitor name", "optional":true }, "health-check-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"health-check", "description":"Disable configured health check configuration", "optional":true }, "protocol":{ "type":"string", "format":"enum", "default":"ldap", "partition-visibility":"shared", "description":"'ldap': Use LDAP (default); 'ldaps': Use LDAP over SSL; 'starttls': Use LDAP StartTLS; ", "enum":[ "ldap", "ldaps", "starttls" ], "optional":true }, "ca-cert":{ "type":"string", "format":"string", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Specify the LDAPS CA cert filename (Trusted LDAPS CA cert filename)", "optional":true }, "ldaps-conn-reuse-idle-timeout":{ "type":"number", "format":"number", "minimum":0, "maximum":86400, "default":0, "partition-visibility":"shared", "description":"Specify LDAPS connection reuse idle timeout value (in seconds) (Specify idle timeout value (in seconds), default is 0 (not reuse LDAPS connection))", "optional":true }, "auth-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'ad': Active Directory. Default; 'open-ldap': OpenLDAP; ", "enum":[ "ad", "open-ldap" ], "optional":true }, "prompt-pw-change-before-exp":{ "type":"number", "format":"number", "minimum":1, "maximum":999, "partition-visibility":"shared", "description":"Prompt user to change password before expiration in N days. This option only takes effect when server type is AD (Prompt user to change password before expiration in N days, default is not to prompt the user)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'admin-bind-success': Admin Bind Success; 'admin-bind-failure': Admin Bind Failure; 'bind-success': User Bind Success; 'bind-failure': User Bind Failure; 'search-success': Search Success; 'search-failure': Search Failure; 'authorize-success': Authorization Success; 'authorize-failure': Authorization Failure; 'timeout-error': Timeout; 'other-error': Other Error; 'request': Request; 'ssl-session-created': TLS/SSL Session Created; 'ssl-session-failure': TLS/SSL Session Failure; 'pw_expiry': Password expiry; 'pw_change_success': Password change success; 'pw_change_failure': Password change failure; ", "enum":[ "all", "admin-bind-success", "admin-bind-failure", "bind-success", "bind-failure", "search-success", "search-failure", "authorize-success", "authorize-failure", "timeout-error", "other-error", "request", "ssl-session-created", "ssl-session-failure", "pw_expiry", "pw_change_success", "pw_change_failure" ] } } } ] }, "packet-capture-template":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/visibility/packet-capture/object-templates/aam-auth-server-ldap-inst-tmpl", "description":"Name of the packet capture template to be bind with this object", "optional":true } }, "required":[ "name" ] } ] } } }, "ocsp":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/server/ocsp", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'stapling-certificate-good': Total OCSP Stapling Good Certificate Response; 'stapling-certificate-revoked': Total OCSP Stapling Revoked Certificate Response; 'stapling-certificate-unknown': Total OCSP Stapling Unknown Certificate Response; 'stapling-request-normal': Total OSCP Stapling Normal Request; 'stapling-request-dropped': Total OCSP Stapling Dropped Request; 'stapling-response-success': Total OCSP Stapling Success Response; 'stapling-response-failure': Total OCSP Stapling Failure Response; 'stapling-response-error': Total OCSP Stapling Error Response; 'stapling-response-timeout': Total OCSP Stapling Timeout Response; 'stapling-response-other': Total OCSP Stapling Other Response; 'request-normal': Total OSCP Normal Request; 'request-dropped': Total OCSP Dropped Request; 'response-success': Total OCSP Success Response; 'response-failure': Total OCSP Failure Response; 'response-error': Total OCSP Error Response; 'response-timeout': Total OCSP Timeout Response; 'response-other': Total OCSP Other Response; 'job-start-error': Total OCSP Job Start Error; 'polling-control-error': Total OCSP Polling Control Error; ", "enum":[ "all", "stapling-certificate-good", "stapling-certificate-revoked", "stapling-certificate-unknown", "stapling-request-normal", "stapling-request-dropped", "stapling-response-success", "stapling-response-failure", "stapling-response-error", "stapling-response-timeout", "stapling-response-other", "request-normal", "request-dropped", "response-success", "response-failure", "response-error", "response-timeout", "response-other", "job-start-error", "polling-control-error" ] } } } ] }, "instance-list":{ "type":"array", "minItems":1, "items":{ "type":"instance" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/server/ocsp/instance/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify OCSP authentication server name", "optional":false }, "url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":255, "partition-visibility":"shared", "description":"Specify the OCSP server's address (Format: http://host[:port]/) (The OCSP server's address(Format: http://host[:port]/))", "optional":true }, "responder-ca":{ "type":"string", "format":"string", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Specify the trusted OCSP responder's CA cert filename", "optional":true }, "responder-cert":{ "type":"string", "format":"string", "minLength":1, "maxLength":245, "partition-visibility":"shared", "description":"Specify the trusted OCSP responder's cert filename", "optional":true }, "health-check":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"health-check-disable", "description":"Check server's health status", "optional":true }, "health-check-string":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "description":"Health monitor name", "optional":true }, "health-check-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"health-check", "description":"Disable configured health check configuration", "optional":true }, "port-health-check":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "not":"port-health-check-disable", "description":"Check port's health status", "optional":true }, "port-health-check-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"port-health-check", "description":"Disable configured port health check configuration", "optional":true }, "http-version":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Set HTTP version (default 1.0)", "optional":true }, "version-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'1.1': HTTP version 1.1; ", "enum":[ "1.1" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'request': Request; 'certificate-good': Good Certificate Response; 'certificate-revoked': Revoked Certificate Response; 'certificate-unknown': Unknown Certificate Response; 'timeout': Timeout; 'fail': Handle OCSP response failed; 'stapling-request': OCSP Stapling Request Send; 'stapling-certificate-good': OCSP Stapling Good Certificate Response; 'stapling-certificate-revoked': OCSP Stapling Revoked Certificate Response; 'stapling-certificate-unknown': OCSP Stapling Unknown Certificate Response; 'stapling-timeout': OCSP Stapling Timeout; 'stapling-fail': Handle OCSP response failed; ", "enum":[ "all", "request", "certificate-good", "certificate-revoked", "certificate-unknown", "timeout", "fail", "stapling-request", "stapling-certificate-good", "stapling-certificate-revoked", "stapling-certificate-unknown", "stapling-timeout", "stapling-fail" ] } } } ] }, "packet-capture-template":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/visibility/packet-capture/object-templates/aam-auth-server-ocsp-inst-tmpl", "description":"Name of the packet capture template to be bind with this object", "optional":true } }, "required":[ "name" ] } ] } } }, "radius":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/server/radius", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'authen_success': Total Authentication Success; 'authen_failure': Total Authentication Failure; 'authorize_success': Total Authorization Success; 'authorize_failure': Total Authorization Failure; 'access_challenge': Total Access-Challenge Message Receive; 'timeout_error': Total Timeout; 'other_error': Total Other Error; 'request': Total Request; 'request-normal': Total Normal Request; 'request-dropped': Total Dropped Request; 'response-success': Total Success Response; 'response-failure': Total Failure Response; 'response-error': Total Error Response; 'response-timeout': Total Timeout Response; 'response-other': Total Other Response; 'job-start-error': Total Job Start Error; 'polling-control-error': Total Polling Control Error; 'accounting-request-sent': Accounting-Request Sent; 'accounting-success': Accounting Success; 'accounting-failure': Accounting Failure; ", "enum":[ "all", "authen_success", "authen_failure", "authorize_success", "authorize_failure", "access_challenge", "timeout_error", "other_error", "request", "request-normal", "request-dropped", "response-success", "response-failure", "response-error", "response-timeout", "response-other", "job-start-error", "polling-control-error", "accounting-request-sent", "accounting-success", "accounting-failure" ] } } } ] }, "instance-list":{ "type":"array", "minItems":1, "items":{ "type":"instance" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/server/radius/instance/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify RADIUS authentication server name", "optional":false }, "host":{ "type":"object", "properties":{ "hostip":{ "type":"string", "format":"host", "minLength":1, "maxLength":31, "partition-visibility":"shared", "not":"hostipv6", "description":"Server's hostname(Length 1-31) or IP address" }, "hostipv6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not":"hostip", "description":"Server's IPV6 address" } } }, "secret":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify the RADIUS server's secret", "optional":true }, "secret-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"The RADIUS server's secret", "optional":true }, "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)", "optional":true }, "port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":1812, "partition-visibility":"shared", "description":"Specify the RADIUS server's authentication port, default is 1812", "optional":true }, "port-hm":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "not":"port-hm-disable", "description":"Check port's health status", "optional":true }, "port-hm-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"port-hm", "description":"Disable configured port health check configuration", "optional":true }, "interval":{ "type":"number", "format":"number", "minimum":1, "maximum":1024, "default":3, "partition-visibility":"shared", "description":"Specify the interval time for resend the request (second), default is 3 seconds (The interval time(second), default is 3 seconds)", "optional":true }, "retry":{ "type":"number", "format":"number", "minimum":1, "maximum":32, "default":5, "partition-visibility":"shared", "description":"Specify the retry number for resend the request, default is 5 (The retry number, default is 5)", "optional":true }, "health-check":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"health-check-disable", "description":"Check server's health status", "optional":true }, "health-check-string":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "description":"Health monitor name", "optional":true }, "health-check-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"health-check", "description":"Disable configured health check configuration", "optional":true }, "accounting-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":1813, "partition-visibility":"shared", "description":"Specify the RADIUS server's accounting port, default is 1813", "optional":true }, "acct-port-hm":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "not":"acct-port-hm-disable", "description":"Specify accounting port health check method", "optional":true }, "acct-port-hm-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"acct-port-hm", "description":"Disable configured accounting port health check configuration", "optional":true }, "auth-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'pap': PAP authentication. Default; 'mschapv2': MS-CHAPv2 authentication; 'mschapv2-pap': Use MS-CHAPv2 first. If server doesn't support it, try PAP; ", "enum":[ "pap", "mschapv2", "mschapv2-pap" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'authen_success': Authentication Success; 'authen_failure': Authentication Failure; 'authorize_success': Authorization Success; 'authorize_failure': Authorization Failure; 'access_challenge': Access-Challenge Message Receive; 'timeout_error': Timeout; 'other_error': Other Error; 'request': Request; 'accounting-request-sent': Accounting-Request Sent; 'accounting-success': Accounting Success; 'accounting-failure': Accounting Failure; ", "enum":[ "all", "authen_success", "authen_failure", "authorize_success", "authorize_failure", "access_challenge", "timeout_error", "other_error", "request", "accounting-request-sent", "accounting-success", "accounting-failure" ] } } } ] }, "packet-capture-template":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/visibility/packet-capture/object-templates/aam-auth-server-rad-inst-tmpl", "description":"Name of the packet capture template to be bind with this object", "optional":true } }, "required":[ "name" ] } ] } } }, "windows":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/server/windows", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'kerberos-request-send': Total Kerberos Request; 'kerberos-response-get': Total Kerberos Response; 'kerberos-timeout-error': Total Kerberos Timeout; 'kerberos-other-error': Total Kerberos Other Error; 'ntlm-authentication-success': Total NTLM Authentication Success; 'ntlm-authentication-failure': Total NTLM Authentication Failure; 'ntlm-proto-negotiation-success': Total NTLM Protocol Negotiation Success; 'ntlm-proto-negotiation-failure': Total NTLM Protocol Negotiation Failure; 'ntlm-session-setup-success': Total NTLM Session Setup Success; 'ntlm-session-setup-failed': Total NTLM Session Setup Failure; 'kerberos-request-normal': Total Kerberos Normal Request; 'kerberos-request-dropped': Total Kerberos Dropped Request; 'kerberos-response-success': Total Kerberos Success Response; 'kerberos-response-failure': Total Kerberos Failure Response; 'kerberos-response-error': Total Kerberos Error Response; 'kerberos-response-timeout': Total Kerberos Timeout Response; 'kerberos-response-other': Total Kerberos Other Response; 'kerberos-job-start-error': Total Kerberos Job Start Error; 'kerberos-polling-control-error': Total Kerberos Polling Control Error; 'ntlm-prepare-req-success': Total NTLM Prepare Request Success; 'ntlm-prepare-req-failed': Total NTLM Prepare Request Failed; 'ntlm-timeout-error': Total NTLM Timeout; 'ntlm-other-error': Total NTLM Other Error; 'ntlm-request-normal': Total NTLM Normal Request; 'ntlm-request-dropped': Total NTLM Dropped Request; 'ntlm-response-success': Total NTLM Success Response; 'ntlm-response-failure': Total NTLM Failure Response; 'ntlm-response-error': Total NTLM Error Response; 'ntlm-response-timeout': Total NTLM Timeout Response; 'ntlm-response-other': Total NTLM Other Response; 'ntlm-job-start-error': Total NTLM Job Start Error; 'ntlm-polling-control-error': Total NTLM Polling Control Error; 'kerberos-pw-expiry': Total Kerberos password expiry; 'kerberos-pw-change-success': Total Kerberos password change success; 'kerberos-pw-change-failure': Total Kerberos password change failure; 'kerberos-validate-kdc-success': Total Kerberos KDC Validation Success; 'kerberos-validate-kdc-failure': Total Kerberos KDC Validation Failure; 'kerberos-generate-kdc-keytab-success': Total Kerberos KDC Keytab Generation Success; 'kerberos-generate-kdc-keytab-failure': Total Kerberos KDC Keytab Generation Failure; 'kerberos-delete-kdc-keytab-success': Total Kerberos KDC Keytab Deletion Success; 'kerberos-delete-kdc-keytab-failure': Total Kerberos KDC Keytab Deletion Failure; 'kerberos-kdc-keytab-count': Current Kerberos KDC Keytab Count; ", "enum":[ "all", "kerberos-request-send", "kerberos-response-get", "kerberos-timeout-error", "kerberos-other-error", "ntlm-authentication-success", "ntlm-authentication-failure", "ntlm-proto-negotiation-success", "ntlm-proto-negotiation-failure", "ntlm-session-setup-success", "ntlm-session-setup-failed", "kerberos-request-normal", "kerberos-request-dropped", "kerberos-response-success", "kerberos-response-failure", "kerberos-response-error", "kerberos-response-timeout", "kerberos-response-other", "kerberos-job-start-error", "kerberos-polling-control-error", "ntlm-prepare-req-success", "ntlm-prepare-req-failed", "ntlm-timeout-error", "ntlm-other-error", "ntlm-request-normal", "ntlm-request-dropped", "ntlm-response-success", "ntlm-response-failure", "ntlm-response-error", "ntlm-response-timeout", "ntlm-response-other", "ntlm-job-start-error", "ntlm-polling-control-error", "kerberos-pw-expiry", "kerberos-pw-change-success", "kerberos-pw-change-failure", "kerberos-validate-kdc-success", "kerberos-validate-kdc-failure", "kerberos-generate-kdc-keytab-success", "kerberos-generate-kdc-keytab-failure", "kerberos-delete-kdc-keytab-success", "kerberos-delete-kdc-keytab-failure", "kerberos-kdc-keytab-count" ] } } } ] }, "instance-list":{ "type":"array", "minItems":1, "items":{ "type":"instance" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/server/windows/instance/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify Windows authentication server name", "optional":false }, "host":{ "type":"object", "properties":{ "hostip":{ "type":"string", "format":"host", "minLength":1, "maxLength":31, "partition-visibility":"shared", "not":"hostipv6", "description":"Specify the Windows server's hostname(Length 1-31) or IP address" }, "hostipv6":{ "type":"string", "format":"ipv6-address", "partition-visibility":"shared", "not":"hostip", "description":"Specify the Windows server's IPV6 address" } } }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "default":10, "partition-visibility":"shared", "description":"Specify connection timeout to server, default is 10 seconds", "optional":true }, "auth-protocol":{ "type":"object", "properties":{ "ntlm-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable NTLM authentication protocol" }, "ntlm-version":{ "type":"number", "format":"number", "minimum":1, "maximum":2, "default":2, "partition-visibility":"shared", "description":"Specify NTLM version, default is 2" }, "ntlm-health-check":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "not":"ntlm-health-check-disable", "description":"Check NTLM port's health status" }, "ntlm-health-check-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"ntlm-health-check", "description":"Disable configured NTLM port health check configuration" }, "kerberos-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable Kerberos authentication protocol" }, "kerberos-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":88, "partition-visibility":"shared", "description":"Specify the Kerberos port, default is 88" }, "kport-hm":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "not":"kport-hm-disable", "description":"Check Kerberos port's health status" }, "kport-hm-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"kport-hm", "description":"Disable configured Kerberos port health check configuration" }, "kerberos-password-change-port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":464, "partition-visibility":"shared", "description":"Specify the Kerbros password change port, default is 464" }, "kdc-validate":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable KDC validation" }, "kerberos-kdc-validation":{ "type":"object", "properties":{ "kdc-spn":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify SPN for KDC validation" }, "kdc-account":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify account for KDC validation" }, "kdc-password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify account password" }, "kdc-pwd":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Account password" }, "encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.)" } } } } }, "realm":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify realm of Windows server", "optional":true }, "support-apacheds-kdc":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable weak cipher (DES CRC/MD5/MD4) and merge AS-REQ in single packet", "optional":true }, "health-check":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"health-check-disable", "description":"Check server's health status", "optional":true }, "health-check-string":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "description":"Health monitor name", "optional":true }, "health-check-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"health-check", "description":"Disable configured health check configuration", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'krb_send_req_success': Kerberos Request; 'krb_get_resp_success': Kerberos Response; 'krb_timeout_error': Kerberos Timeout; 'krb_other_error': Kerberos Other Error; 'krb_pw_expiry': Kerberos password expiry; 'krb_pw_change_success': Kerberos password change success; 'krb_pw_change_failure': Kerberos password change failure; 'ntlm_proto_nego_success': NTLM Protocol Negotiation Success; 'ntlm_proto_nego_failure': NTLM Protocol Negotiation Failure; 'ntlm_session_setup_success': NTLM Session Setup Success; 'ntlm_session_setup_failure': NTLM Session Setup Failure; 'ntlm_prepare_req_success': NTLM Prepare Request Success; 'ntlm_prepare_req_error': NTLM Prepare Request Error; 'ntlm_auth_success': NTLM Authentication Success; 'ntlm_auth_failure': NTLM Authentication Failure; 'ntlm_timeout_error': NTLM Timeout; 'ntlm_other_error': NTLM Other Error; 'krb_validate_kdc_success': Kerberos KDC Validation Success; 'krb_validate_kdc_failure': Kerberos KDC Validation Failure; ", "enum":[ "all", "krb_send_req_success", "krb_get_resp_success", "krb_timeout_error", "krb_other_error", "krb_pw_expiry", "krb_pw_change_success", "krb_pw_change_failure", "ntlm_proto_nego_success", "ntlm_proto_nego_failure", "ntlm_session_setup_success", "ntlm_session_setup_failure", "ntlm_prepare_req_success", "ntlm_prepare_req_error", "ntlm_auth_success", "ntlm_auth_failure", "ntlm_timeout_error", "ntlm_other_error", "krb_validate_kdc_success", "krb_validate_kdc_failure" ] } } } ] }, "packet-capture-template":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/visibility/packet-capture/object-templates/aam-auth-server-win-inst-tmpl", "description":"Name of the packet capture template to be bind with this object", "optional":true } }, "required":[ "name" ] } ] } } } } }, "log":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/log", "properties":{ "enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable authentication logs" }, "facility":{ "type":"string", "format":"enum", "default":"local0", "partition-visibility":"shared", "description":"'local0': Local use; 'local1': Local use; 'local2': Local use; 'local3': Local use; 'local4': Local use; 'local5': Local use; 'local6': Local use; 'local7': Local use; ", "enum":[ "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7" ] }, "format":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'syslog': Syslog Format (default); 'cef': Common Event Format; ", "enum":[ "syslog", "cef" ] }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "account":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/account", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'request-normal': Total Normal Request; 'request-dropped': Total Dropped Request; 'response-success': Total Success Response; 'response-failure': Total Failure Response; 'response-error': Total Error Response; 'response-timeout': Total Timeout Response; 'response-other': Total Other Response; ", "enum":[ "all", "request-normal", "request-dropped", "response-success", "response-failure", "response-error", "response-timeout", "response-other" ] } } } ] }, "kerberos-spn-list":{ "type":"array", "minItems":1, "items":{ "type":"kerberos-spn" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/account/kerberos-spn/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify AD account name", "optional":false }, "realm":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify Kerberos realm", "optional":true }, "account":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify domain account for SPN", "optional":true }, "service-principal-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify service principal name", "optional":true }, "password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify password of domain account", "optional":true }, "secret-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Password of AD account", "optional":true }, "encrypted":{ "type":"encrypted", "format":"encrypted", "partition-visibility":"shared", "description":"Do NOT use this option manually. (This is an A10 reserved keyword.)", "optional":true }, "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 } }, "required":[ "name" ] } ] } } }, "saml":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/saml", "properties":{ "global":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/saml/global", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'requests-to-a10saml': Total Request to A10 SAML Service; 'responses-from-a10saml': Total Response from A10 SAML Service; 'sp-metadata-export-req': Total Metadata Export Request; 'sp-metadata-export-success': Toal Metadata Export Success; 'login-auth-req': Total Login Authentication Request; 'login-auth-resp': Total Login Authentication Response; 'acs-req': Total SAML Single-Sign-On Request; 'acs-success': Total SAML Single-Sign-On Success; 'acs-authz-fail': Total SAML Single-Sign-On Authorization Fail; 'acs-error': Total SAML Single-Sign-On Error; 'slo-req': Total Single Logout Request; 'slo-success': Total Single Logout Success; 'slo-error': Total Single Logout Error; 'sp-slo-req': Total SP-initiated Single Logout Request; 'glo-slo-success': Total Global Logout Success; 'loc-slo-success': Total Local Logout Success; 'par-slo-success': Total Partial Logout Success; 'relay-req': relay-req; 'relay-success': relay-success; 'relay-fail': relay-fail; 'relay-error': relay-error; 'other-error': Total Other Error; ", "enum":[ "all", "requests-to-a10saml", "responses-from-a10saml", "sp-metadata-export-req", "sp-metadata-export-success", "login-auth-req", "login-auth-resp", "acs-req", "acs-success", "acs-authz-fail", "acs-error", "slo-req", "slo-success", "slo-error", "sp-slo-req", "glo-slo-success", "loc-slo-success", "par-slo-success", "relay-req", "relay-success", "relay-fail", "relay-error", "other-error" ] } } } ] } } }, "session":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/saml/session", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "metadata":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/saml/metadata", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "metadata-monitor":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/saml/metadata-monitor", "properties":{ "status":{ "type":"string", "format":"enum", "default":"enable", "partition-visibility":"shared", "description":"'enable': Enable SAML metadata out-of-sync detection; 'disable': Disable SAML metadata out-of-sync detection; ", "enum":[ "enable", "disable" ] }, "acs-continuous-fail-threshold":{ "type":"number", "format":"number", "minimum":2, "maximum":254, "partition-visibility":"shared", "description":"Specify how many ACS continuous fails will trigger metadata reload (ACS continuous fail threshold (default: 10))" }, "acs-missing-threshold":{ "type":"number", "format":"number", "minimum":10, "maximum":254, "partition-visibility":"shared", "description":"Specify how many ACS request missing in the period will trigger metadata reload (ACS request missing threshold (default: 100))" }, "acs-missing-period":{ "type":"number", "format":"number", "minimum":1, "maximum":254, "partition-visibility":"shared", "description":"Specify how long no acs request will trigger metadata reload (in seconds (default: 60))" }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" } } }, "service-provider-list":{ "type":"array", "minItems":1, "items":{ "type":"service-provider" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/saml/service-provider/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify SAML authentication service provider name", "optional":false }, "adfs-ws-federation":{ "type":"object", "properties":{ "ws-federation-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable ADFS WS-Federation" } } }, "artifact-resolution-service":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "artifact-index":{ "type":"number", "format":"number", "minimum":0, "maximum":5, "partition-visibility":"shared", "description":"The index of artifact resolution service" }, "artifact-location":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"The location of artifact resolution service. (ex. /SAML/POST)" }, "artifact-binding":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'soap': SOAP binding of artifact resolution service; ", "enum":[ "soap" ] } } } ] }, "assertion-consuming-service":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "assertion-index":{ "type":"number", "format":"number", "minimum":0, "maximum":5, "partition-visibility":"shared", "description":"The index of assertion consuming service" }, "assertion-location":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"The location of assertion consuming service endpoint. (ex. /SAML/POST)" }, "assertion-binding":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'artifact': Artifact binding of assertion consuming service; 'paos': PAOS binding of assertion consuming service; 'post': POST binding of assertion consuming service; ", "enum":[ "artifact", "paos", "post" ] } } } ] }, "single-logout-service":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "SLO-location":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"The location of name-id management service. (ex. /SAML/POST)" }, "SLO-binding":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'post': POST binding of single logout service; 'redirect': Redirect binding of single logout service; 'soap': SOAP binding of single logout service; ", "enum":[ "post", "redirect", "soap" ] } } } ] }, "SP-initiated-single-logout-service":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "SP-SLO-location":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"The location of SP-initiated single logout service endpoint. (ex. /Logout)" }, "asynchronous":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"the IDP will not send a logout response to AX" } } } ] }, "metadata-export-service":{ "type":"object", "properties":{ "md-export-location":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify the URI to export SP metadata (Export URI. Default is /A10SP_Metadata)" }, "sign-xml":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Sign exported SP metadata XML with SP's certificate" } } }, "certificate":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"SAML service provider certificate file (PFX format is required.)", "optional":true }, "entity-id":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":1023, "partition-visibility":"shared", "description":"SAML service provider entity ID", "optional":true }, "saml-request-signed":{ "type":"object", "properties":{ "saml-request-signed-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable signing signature for SAML (Authn/Artifact Resolve) requests" } } }, "soap-tls-certificate-validate":{ "type":"object", "properties":{ "soap-tls-certificate-validate-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable verification for server certificate in TLS session when resolving artificate" } } }, "signature-algorithm":{ "type":"string", "format":"enum", "default":"SHA1", "partition-visibility":"shared", "description":"'SHA1': use SHA1 as signature algorithm (default); 'SHA256': use SHA256 as signature algorithm; ", "enum":[ "SHA1", "SHA256" ], "optional":true }, "require-assertion-signed":{ "type":"object", "properties":{ "require-assertion-signed-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable required signing of SAML assertion" } } }, "service-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"SAML service provider service URL (ex. https://www.a10networks.com/saml.sso)", "optional":true }, "bad-request-redirect-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify URL to redirect", "optional":true }, "acs-uri-bypass":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"After user authenticated, bypass requests with assertion-consuming-service location URI", "optional":true }, "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 }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'sp-metadata-export-req': Metadata Export Request; 'sp-metadata-export-success': Metadata Export Success; 'login-auth-req': Login Authentication Request; 'login-auth-resp': Login Authentication Response; 'acs-req': SAML Single-Sign-On Request; 'acs-success': SAML Single-Sign-On Success; 'acs-authz-fail': SAML Single-Sign-On Authorization Fail; 'acs-error': SAML Single-Sign-On Error; 'slo-req': Single Logout Request; 'slo-success': Single Logout Success; 'slo-error': Single Logout Error; 'sp-slo-req': SP-initiated Single Logout Request; 'glo-slo-success': Total Global Logout Success; 'loc-slo-success': Total Local Logout Success; 'par-slo-success': Total Partial Logout Success; 'other-error': Other Error; ", "enum":[ "all", "sp-metadata-export-req", "sp-metadata-export-success", "login-auth-req", "login-auth-resp", "acs-req", "acs-success", "acs-authz-fail", "acs-error", "slo-req", "slo-success", "slo-error", "sp-slo-req", "glo-slo-success", "loc-slo-success", "par-slo-success", "other-error" ] } } } ] }, "packet-capture-template":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/visibility/packet-capture/object-templates/aam-auth-saml-service-prov-tmpl", "description":"Name of the packet capture template to be bind with this object", "optional":true } }, "required":[ "name" ] } ] }, "identity-provider-list":{ "type":"array", "minItems":1, "items":{ "type":"identity-provider" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/saml/identity-provider/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"SAML authentication identity provider name", "optional":false }, "metadata":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"URL of SAML identity provider's metadata file", "optional":true }, "reload-metadata":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Reload IdP's metadata immediately", "optional":true }, "reload-interval":{ "type":"number", "format":"number", "minimum":1, "maximum":86400, "default":28800, "partition-visibility":"shared", "description":"Specify URI metadata reload period (Specify URI metadata reload period in seconds, default is 28800)", "optional":true }, "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 } }, "required":[ "name" ] } ] } } }, "oauth":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/oauth", "properties":{ "global":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/oauth/global", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'auth-req': auth-req; 'auth-succ': auth-succ; 'auth-fail': auth-fail; 'auth-error': auth-error; 'relay-req': relay-req; 'relay-succ': relay-succ; 'relay-fail': relay-fail; 'other-error': other-error; ", "enum":[ "all", "auth-req", "auth-succ", "auth-fail", "auth-error", "relay-req", "relay-succ", "relay-fail", "other-error" ] } } } ] } } }, "authorization-server-list":{ "type":"array", "minItems":1, "items":{ "type":"authorization-server" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/oauth/authorization-server/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify authorization server object name", "optional":false }, "issuer":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify openid provider name for authorization", "optional":true }, "authorization-endpoint":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify URI for authorization", "optional":true }, "client-method":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'ignored': Clients' browser will send data according to server spec (default); 'post': Clients' browser will send data by POST; 'get': Clients' browser will send data by GET; ", "enum":[ "ignored", "post", "get" ], "optional":true }, "token-endpoint":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify URI for token exchange", "optional":true }, "server-method":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'post': AX will send data to server by POST (default); 'get': AX will send data to server by GET; ", "enum":[ "post", "get" ], "optional":true }, "verification-cert":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"verification-jwks", "description":"Specify certificate to verify ID token signature", "optional":true }, "verification-jwks":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"verification-cert", "description":"Specify jwks file to verify ID token signature", "optional":true }, "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 }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'auth-req': auth-req; 'auth-succ': auth-succ; 'auth-fail': auth-fail; 'auth-error': auth-error; 'other-error': other-error; ", "enum":[ "all", "auth-req", "auth-succ", "auth-fail", "auth-error", "other-error" ] } } } ] } }, "required":[ "name" ] } ] }, "client-list":{ "type":"array", "minItems":1, "items":{ "type":"client" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/oauth/client/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify client object name", "optional":false }, "parameter-nonce-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable nonce parameter for authorization and token request", "optional":true }, "no-reply":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"AX will not check the nonce value in response", "optional":true }, "token-lifetime":{ "type":"number", "format":"number", "minimum":1, "maximum":2592000, "partition-visibility":"shared", "not":"infinity", "optional":true }, "infinity":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"token-lifetime", "description":"Auth session never time out whatever value oauth servers' response", "optional":true }, "client-id":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify oauth client-id", "optional":true }, "client-secret":{ "type":"string", "format":"password", "minLength":1, "maxLength":127, "partition-visibility":"shared", "optional":true }, "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)", "optional":true }, "type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'openid-connect': openid-connect; ", "enum":[ "openid-connect" ], "optional":true }, "grant-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'implicit': The authorization server will return access token directly.; 'authorization-code': The authorization server will respond with code which can be exchange for access token.; 'hybrid-code-id-token': The authorization server will respond with both code and id token.; 'hybrid-code-token': The authorization server will respond with both code and access token.; 'hybrid-all': The authorization server will respond with code, access token and id token; ", "enum":[ "implicit", "authorization-code", "hybrid-code-id-token", "hybrid-code-token", "hybrid-all" ], "optional":true }, "redirection-endpoint":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Oauth client redirection endpoint service URL.", "optional":true }, "session-init-ttl":{ "type":"number", "format":"number", "minimum":1, "maximum":60, "partition-visibility":"shared", "description":"TTL for Thunder to wait for first response from authorization server", "optional":true }, "scope":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify request scope parameters (e.g. profile email address phone)", "optional":true }, "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 } }, "required":[ "name" ] } ] } } }, "service-group-list":{ "type":"array", "minItems":1, "items":{ "type":"service-group" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/service-group/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify AAM service group name", "optional":false }, "protocol":{ "type":"string", "format":"enum", "partition-visibility":"shared", "modify-not-allowed":1, "description":"'tcp': TCP AAM service; 'udp': UDP AAM service; ", "enum":[ "tcp", "udp" ], "optional":true }, "lb-method":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'round-robin': Round robin on server level; ", "enum":[ "round-robin" ], "optional":true }, "health-check":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/health/monitor", "not":"health-check-disable", "description":"Health Check (Monitor Name)", "optional":true }, "health-check-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"health-check", "description":"Disable health check", "optional":true }, "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 }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'server_selection_fail_drop': Drops due to Service selection failure; 'server_selection_fail_reset': Resets sent out for Service selection failure; 'service_peak_conn': Peak connection count for the Service Group; 'service_healthy_host': Service Group healthy host count; 'service_unhealthy_host': Service Group unhealthy host count; 'service_req_count': Service Group request count; 'service_resp_count': Service Group response count; 'service_resp_2xx': Service Group response 2xx count; 'service_resp_3xx': Service Group response 3xx count; 'service_resp_4xx': Service Group response 4xx count; 'service_resp_5xx': Service Group response 5xx count; 'service_curr_conn_overflow': Current connection counter overflow count; ", "enum":[ "all", "server_selection_fail_drop", "server_selection_fail_reset", "service_peak_conn", "service_healthy_host", "service_unhealthy_host", "service_req_count", "service_resp_count", "service_resp_2xx", "service_resp_3xx", "service_resp_4xx", "service_resp_5xx", "service_curr_conn_overflow" ] } } } ] }, "packet-capture-template":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/visibility/packet-capture/object-templates/aam-auth-service-group-tmpl", "description":"Name of the packet capture template to be bind with this object", "optional":true }, "member-list":{ "type":"array", "minItems":1, "items":{ "type":"member" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/service-group/{name}/member/{name}+{port}", "array":[ { "properties":{ "name":{ "type":"string", "format":"comp-string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/server/ldap", "description":"Member name", "optional":false }, "port":{ "type":"number", "format":"number", "minimum":1, "maximum":65534, "default":65534, "partition-visibility":"shared", "description":"Port number", "optional":false }, "member-state":{ "type":"string", "format":"enum", "default":"enable", "partition-visibility":"shared", "description":"'enable': Enable member service port; 'disable': Disable member service port; ", "enum":[ "enable", "disable" ], "optional":true }, "member-priority":{ "type":"number", "format":"number", "minimum":1, "maximum":16, "partition-visibility":"shared", "description":"Priority of Port in the Group", "optional":true }, "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 }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'total_fwd_bytes': Bytes processed in forward direction; 'total_fwd_pkts': Packets processed in forward direction; 'total_rev_bytes': Bytes processed in reverse direction; 'total_rev_pkts': Packets processed in reverse direction; 'total_conn': Total established connections; 'total_rev_pkts_inspected': Total reverse packets inspected; 'total_rev_pkts_inspected_status_code_2xx': Total reverse packets inspected status code 2xx; 'total_rev_pkts_inspected_status_code_non_5xx': Total reverse packets inspected status code non 5xx; 'curr_req': Current requests; 'total_req': Total requests; 'total_req_succ': Total requests successful; 'peak_conn': peak_conn; 'response_time': Response time; 'fastest_rsp_time': Fastest response time; 'slowest_rsp_time': Slowest response time; 'curr_ssl_conn': Current SSL connections; 'total_ssl_conn': Total SSL connections; 'curr_conn_overflow': Current connection counter overflow count; ", "enum":[ "all", "total_fwd_bytes", "total_fwd_pkts", "total_rev_bytes", "total_rev_pkts", "total_conn", "total_rev_pkts_inspected", "total_rev_pkts_inspected_status_code_2xx", "total_rev_pkts_inspected_status_code_non_5xx", "curr_req", "total_req", "total_req_succ", "peak_conn", "response_time", "fastest_rsp_time", "slowest_rsp_time", "curr_ssl_conn", "total_ssl_conn", "curr_conn_overflow" ] } } } ] }, "packet-capture-template":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/visibility/packet-capture/object-templates/aam-auth-service-group-mem-tmpl", "description":"Name of the packet capture template to be bind with this object", "optional":true } }, "required":[ "name", "port" ] } ] } }, "required":[ "name" ] } ] }, "relay":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/relay", "properties":{ "http-basic":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/relay/http-basic", "properties":{ "instance-list":{ "type":"array", "minItems":1, "items":{ "type":"instance" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/relay/http-basic/instance/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify HTTP basic authentication relay name", "optional":false }, "domain":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "description":"Specify user domain, default is null", "optional":true }, "domain-format":{ "type":"string", "format":"enum", "default":"down-level-logon-name", "partition-visibility":"shared", "description":"'user-principal-name': Append domain with User Principal Name format. (e.g. user@domain); 'down-level-logon-name': Append domain with Down-Level Logon Name format. (e.g. domain\\user); ", "enum":[ "user-principal-name", "down-level-logon-name" ], "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'success': Success; 'no-creds': No Credential; 'bad-req': Bad Request; 'unauth': Unauthorized; 'forbidden': Forbidden; 'not-found': Not Found; 'server-error': Internal Server Error; 'unavailable': Service Unavailable; ", "enum":[ "all", "success", "no-creds", "bad-req", "unauth", "forbidden", "not-found", "server-error", "unavailable" ] } } } ] }, "packet-capture-template":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/visibility/packet-capture/object-templates/aam-auth-relay-hbase-inst-tmpl", "description":"Name of the packet capture template to be bind with this object", "optional":true } }, "required":[ "name" ] } ] } } }, "kerberos":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/relay/kerberos", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'request-send': Total Request Send; 'response-get': Total Response Get; 'timeout-error': Total Timeout; 'other-error': Total Other Error; 'request-normal': Total Normal Request; 'request-dropped': Total Dropped Request; 'response-success': Total Success Response; 'response-failure': Total Failure Response; 'response-error': Total Error Response; 'response-timeout': Total Timeout Response; 'response-other': Total Other Response; 'job-start-error': Total Job Start Error; 'polling-control-error': Total Polling Control Error; ", "enum":[ "all", "request-send", "response-get", "timeout-error", "other-error", "request-normal", "request-dropped", "response-success", "response-failure", "response-error", "response-timeout", "response-other", "job-start-error", "polling-control-error" ] } } } ] }, "instance-list":{ "type":"array", "minItems":1, "items":{ "type":"instance" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/relay/kerberos/instance/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify Kerberos authentication relay name", "optional":false }, "kerberos-realm":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify the kerberos realm", "optional":true }, "kerberos-kdc":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"kerberos-kdc-service-group", "description":"Specify the kerberos kdc ip or host name", "optional":true }, "kerberos-kdc-service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/service-group", "not":"kerberos-kdc", "description":"Specify an authentication service group as multiple KDCs", "optional":true }, "kerberos-account":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify the kerberos account name", "optional":true }, "password":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify password of Kerberos password", "optional":true }, "secret-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"The kerberos client password", "optional":true }, "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)", "optional":true }, "port":{ "type":"number", "format":"number", "minimum":1, "maximum":65535, "default":88, "partition-visibility":"shared", "description":"Specify The KDC port, default is 88", "optional":true }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "default":10, "partition-visibility":"shared", "description":"Specify timeout for kerberos transport, default is 10 seconds (The timeout, default is 10 seconds)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'request-send': Request Send; 'response-receive': Response Receive; 'current-requests-of-user': Current Pending Requests of User; 'tickets': Tickets; ", "enum":[ "all", "request-send", "response-receive", "current-requests-of-user", "tickets" ] } } } ] } }, "required":[ "name" ] } ] } } }, "form-based":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/relay/form-based", "properties":{ "instance-list":{ "type":"array", "minItems":1, "items":{ "type":"instance" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/relay/form-based/instance/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify form-based authentication relay name", "optional":false }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'request': Request; 'invalid_srv_rsp': Invalid Server Response; 'post_fail': POST Failed; 'invalid_cred': Invalid Credential; 'bad_req': Bad Request; 'not_fnd': Not Found; 'error': Internal Server Error; 'other_error': Other Error; ", "enum":[ "all", "request", "invalid_srv_rsp", "post_fail", "invalid_cred", "bad_req", "not_fnd", "error", "other_error" ] } } } ] }, "packet-capture-template":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/visibility/packet-capture/object-templates/aam-auth-relay-form-inst-tmpl", "description":"Name of the packet capture template to be bind with this object", "optional":true }, "request-uri-list":{ "type":"array", "minItems":1, "items":{ "type":"request-uri" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri/{match-type}+{uri}", "array":[ { "properties":{ "match-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'equals': URI exactly matches the string; 'contains': URI string contains another sub string; 'starts-with': URI string starts with sub string; 'ends-with': URI string ends with sub string; ", "enum":[ "equals", "contains", "starts-with", "ends-with" ], "optional":false }, "uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify request URI", "optional":false }, "user-variable":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify username variable name", "optional":true }, "password-variable":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify password variable name", "optional":true }, "domain-variable":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify domain variable name", "optional":true }, "other-variables":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify other variables (n1=v1&n2=v2) in form relay", "optional":true }, "max-packet-collect-size":{ "type":"number", "format":"number", "minimum":1024, "maximum":2097152, "default":1048576, "partition-visibility":"shared", "description":"Specify the max packet collection size in bytes, default is 1MB", "optional":true }, "cookie":{ "type":"object", "properties":{ "cookie-value":{ "type":"object", "properties":{ "cookie-value":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify cookie in POST packet" } } } } }, "action-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify the action-URI", "optional":true }, "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 } }, "required":[ "match-type", "uri" ] } ] } }, "required":[ "name" ] } ] } } }, "ntlm-list":{ "type":"array", "minItems":1, "items":{ "type":"ntlm" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/relay/ntlm/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify NTLM authentication relay name", "optional":false }, "large-request-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable NTLM relay processing for large requests", "optional":true }, "domain":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "description":"Specify NTLM domain, default is null", "optional":true }, "version":{ "type":"number", "format":"number", "minimum":1, "maximum":2, "default":2, "partition-visibility":"shared", "description":"Specify NTLM version, default is NTLM 2", "optional":true }, "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 }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'success': Success; 'failure': Failure; 'request': Request; 'response': Response; 'http-code-200': HTTP 200 OK; 'http-code-400': HTTP 400 Bad Request; 'http-code-401': HTTP 401 Unauthorized; 'http-code-403': HTTP 403 Forbidden; 'http-code-404': HTTP 404 Not Found; 'http-code-500': HTTP 500 Internal Server Error; 'http-code-503': HTTP 503 Service Unavailable; 'http-code-other': Other HTTP Response; 'buffer-alloc-fail': Buffer Allocation Failure; 'encoding-fail': Encoding Failure; 'insert-header-fail': Insert Header Failure; 'parse-header-fail': Parse Header Failure; 'internal-error': Internal Error; 'ntlm-auth-skipped': Requests for which NTLM relay is skipped; 'large-request-processing': Requests invoking large request processing; 'large-request-flushed': Large requests sent to server; 'head-negotiate-request-sent': HEAD requests sent with NEGOTIATE header; 'head-auth-request-sent': HEAD requests sent with AUTH header; ", "enum":[ "all", "success", "failure", "request", "response", "http-code-200", "http-code-400", "http-code-401", "http-code-403", "http-code-404", "http-code-500", "http-code-503", "http-code-other", "buffer-alloc-fail", "encoding-fail", "insert-header-fail", "parse-header-fail", "internal-error", "ntlm-auth-skipped", "large-request-processing", "large-request-flushed", "head-negotiate-request-sent", "head-auth-request-sent" ] } } } ] }, "packet-capture-template":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/visibility/packet-capture/object-templates/aam-auth-relay-ntlm-tmpl", "description":"Name of the packet capture template to be bind with this object", "optional":true } }, "required":[ "name" ] } ] }, "ws-federation-list":{ "type":"array", "minItems":1, "items":{ "type":"ws-federation" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/relay/ws-federation/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify WS-Federation authentication relay name", "optional":false }, "application-server":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'sharepoint': Microsoft SharePoint; 'exchange-owa': Microsoft Exchange OWA; ", "enum":[ "sharepoint", "exchange-owa" ], "optional":true }, "authentication-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify WS-Federation relay URI, default is /_trust/", "optional":true }, "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 }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'request': Request; 'success': Success; 'failure': Failure; ", "enum":[ "all", "request", "success", "failure" ] } } } ] }, "packet-capture-template":{ "type":"string", "format":"string", "minLength":1, "maxLength":128, "partition-visibility":"shared", "$ref":"/axapi/v3/visibility/packet-capture/object-templates/aam-auth-relay-ws-fed-tmpl", "description":"Name of the packet capture template to be bind with this object", "optional":true } }, "required":[ "name" ] } ] }, "saml-list":{ "type":"array", "minItems":1, "items":{ "type":"saml" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/relay/saml/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify SAML authentication relay name", "optional":false }, "relay-acs-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify the backend server assertion consuming service URI", "optional":true }, "match-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'equals': URI exactly matches the string; 'contains': URI string contains another sub string; 'starts-with': URI string starts with sub string; 'ends-with': URI string ends with sub string; ", "enum":[ "equals", "contains", "starts-with", "ends-with" ], "optional":true }, "match-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Match URI", "optional":true }, "server-cookie-name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify the cookie name that used by backend server for authenticated users", "optional":true }, "idp-auth-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify the URI for IDP to handle SAML authentication request", "optional":true }, "value":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "not":"method", "description":"Use the fixed string as the RelayState", "optional":true }, "method":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not":"value", "description":"'get-from-backend': Get RelayState parameter from backend server; 'request-uri': Use the (URL encoded) current request-uri as the RelayState; ", "enum":[ "get-from-backend", "request-uri" ], "optional":true }, "retry-number":{ "type":"number", "format":"number", "minimum":0, "maximum":10, "default":0, "partition-visibility":"shared", "description":"Specify how many continuous fail for SAML relay will trigger. Default will not retry.", "optional":true }, "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 }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'request': Request; 'success': Success; 'failure': Failure; 'error': Error; ", "enum":[ "all", "request", "success", "failure", "error" ] } } } ] } }, "required":[ "name" ] } ] }, "oauth-list":{ "type":"array", "minItems":1, "items":{ "type":"oauth" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/relay/oauth/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify oauth authentication relay name", "optional":false }, "relay-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'access-token': Relay access token to backend; 'id-token': Relay JWT to backend; ", "enum":[ "access-token", "id-token" ], "optional":true }, "match-type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "not":"all", "description":"'equals': URI exactly matches the string; 'contains': URI string contains another sub string; 'starts-with': URI string starts with sub string; 'ends-with': URI string ends with sub string; ", "enum":[ "equals", "contains", "starts-with", "ends-with" ], "optional":true }, "all":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "not":"match-type", "description":"All URI can be relay", "optional":true }, "match-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "optional":true }, "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 }, "sampling-enable":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "counters1":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'all': all; 'relay-req': relay-req; 'relay-succ': relay-succ; 'relay-fail': relay-fail; ", "enum":[ "all", "relay-req", "relay-succ", "relay-fail" ] } } } ] } }, "required":[ "name" ] } ] } } }, "jwt-list":{ "type":"array", "minItems":1, "items":{ "type":"jwt" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/jwt/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify JWT issuer template name", "optional":false }, "issuer":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify JWT issuer claim value", "optional":true }, "action":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'redirect': redirect JWT to specific URI; 'relay': relay JWT to back-end; ", "enum":[ "redirect", "relay" ], "optional":true }, "jwt-relay-uri":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"Specify JWT relay URI (for relay action)", "optional":true }, "token-lifetime":{ "type":"number", "format":"number", "minimum":0, "maximum":86400, "default":300, "partition-visibility":"shared", "description":"Specify JWT token lifetime (Specify lifetime (in seconds), default is 300.)", "optional":true }, "signature-secret":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify the JWT signature secret", "optional":true }, "secret-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":128, "partition-visibility":"shared", "description":"The JWT signature secret", "optional":true }, "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)", "optional":true }, "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 } }, "required":[ "name" ] } ] }, "captcha":{ "type":"object", "$ref":"/axapi/v3/aam/authentication/captcha", "properties":{ "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object" }, "instance-list":{ "type":"array", "minItems":1, "items":{ "type":"instance" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/captcha/instance/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify captcha profile name", "optional":false }, "secret-key":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Specify secret key", "optional":true }, "secret-key-string":{ "type":"string", "format":"password", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Secret key string", "optional":true }, "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)", "optional":true }, "url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify verify API URL, default scheme is https", "optional":true }, "method":{ "type":"string", "format":"enum", "default":"POST", "partition-visibility":"shared", "description":"'POST': API uses POST method; 'GET': API uses GET method; ", "enum":[ "POST", "GET" ], "optional":true }, "timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":255, "default":10, "partition-visibility":"shared", "description":"Specify timeout for verify API response (Specify timeout value, default is 10 seconds)", "optional":true }, "secret-key-param-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify secret key parameter name used in API (Set parameter name)", "optional":true }, "token-param-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify token parameter name used in API (Set parameter name)", "optional":true }, "resp-result-field-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify result field name used in JSON response (Set field name)", "optional":true }, "resp-error-code-field-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify error code field name used in JSON response (Set field name)", "optional":true }, "send-client-ip":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Send client IP address in API", "optional":true }, "client-ip-param-name":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify client ip parameter name used in API (Set parameter name)", "optional":true }, "uuid":{ "type":"string", "format":"string", "minLength":1, "maxLength":64, "partition-visibility":"shared", "modify-not-allowed":1, "description":"uuid of the object", "optional":true } }, "required":[ "name" ] } ] } } }, "template-list":{ "type":"array", "minItems":1, "items":{ "type":"template" }, "uniqueItems":true, "$ref":"/axapi/v3/aam/authentication/template/{name}", "array":[ { "properties":{ "name":{ "type":"string", "format":"string", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Authentication template name", "optional":false }, "type":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'saml': SAML authentication template; 'standard': Standard authentication template; 'oauth': Oauth 2.0 authentication template; ", "enum":[ "saml", "standard", "oauth" ], "optional":true }, "auth-sess-mode":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'cookie-based': Track auth-session by cookie (default); 'ip-based': Track auth-session by client IP; ", "enum":[ "cookie-based", "ip-based" ], "optional":true }, "saml-sp":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify SAML service provider", "optional":true }, "saml-idp":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify SAML identity provider", "optional":true }, "oauth-authorization-server":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify OAUTH authorization server", "optional":true }, "oauth-client":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "description":"Specify OAUTH client", "optional":true }, "cookie-domain":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "cookie-dmn":{ "type":"string", "format":"string-rlx", "minLength":2, "maxLength":63, "partition-visibility":"shared", "description":"Specify domain scope for the authentication (ex: .a10networks.com)" } } } ] }, "cookie-domain-group":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "cookie-dmngrp":{ "type":"number", "format":"number", "minimum":0, "maximum":31, "partition-visibility":"shared", "description":"Specify group id to join in the cookie-domain" } } } ] }, "cookie-max-age":{ "type":"number", "format":"number", "minimum":0, "maximum":2592000, "default":604800, "partition-visibility":"shared", "description":"Configure Max-Age for authentication session cookie (Configure Max-Age in seconds, 0 for no Max-Age/Expires attributes. Default is 604800 (1 week).)", "optional":true }, "cookie-secure-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable secure attribute for AAM cookies", "optional":true }, "cookie-httponly-enable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable httponly attribute for AAM cookies", "optional":true }, "cookie-samesite":{ "type":"string", "format":"enum", "partition-visibility":"shared", "description":"'strict': Specify SameSite attribute as Strict for AAM cookie; 'lax': Specify SameSite attribute as Lax for AAM cookie; 'none': Specify SameSite attribute as None for AAM cookie; ", "enum":[ "strict", "lax", "none" ], "optional":true }, "max-session-time":{ "type":"number", "format":"number", "minimum":0, "maximum":86400, "partition-visibility":"shared", "description":"Specify default SAML token lifetime (Specify lifetime (in seconds) of SAML token when it not provided by token attributes, default is 28800. (0 for indefinite))", "optional":true }, "local-logging":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Enable local logging", "optional":true }, "logon":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/logon/form-based", "description":"Specify authentication logon (Specify authentication logon template name)", "optional":true }, "logout-idle-timeout":{ "type":"number", "format":"number", "minimum":1, "maximum":86400, "default":300, "partition-visibility":"shared", "description":"Specify idle logout time (Specify idle timeout in seconds, default is 300)", "optional":true }, "logout-url":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "description":"Specify logout url (Specify logout url string)", "optional":true }, "forward-logout-disable":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Disable forward logout request to backend application server. The config-field logout-url must be configured first", "optional":true }, "relay":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/relay/http-basic/instance", "description":"Specify authentication relay (Specify authentication relay template name)", "optional":true }, "jwt":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/jwt", "description":"Specify authentication jwt template", "optional":true }, "server":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/server/ldap/instance", "not":"service-group", "description":"Specify authentication server (Specify authentication server template name)", "optional":true }, "service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/service-group", "not-list":[ "server", "chain-server" ], "description":"Bind an authentication service group to this template (Specify authentication service group name)", "optional":true }, "account":{ "type":"string", "format":"string", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/account/kerberos-spn", "description":"Specify AD domain account", "optional":true }, "captcha":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/captcha/instance", "description":"Specify captcha profile (Specify captcha proflie name)", "optional":true }, "accounting-server":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/server/radius/instance", "not":"accounting-service-group", "description":"Specify a RADIUS accounting server", "optional":true }, "accounting-service-group":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/service-group", "not":"accounting-server", "description":"Specify an authentication service group for RADIUS accounting", "optional":true }, "redirect-hostname":{ "type":"string", "format":"host", "minLength":1, "maxLength":31, "partition-visibility":"shared", "description":"Hostname(Length 1-31) for transparent-proxy authentication", "optional":true }, "modify-content-security-policy":{ "type":"number", "format":"flag", "default":0, "partition-visibility":"shared", "description":"Put redirect-uri or service-principal-name into CSP header to avoid CPS break authentication process", "optional":true }, "log":{ "type":"string", "format":"enum", "default":"use-partition-level-config", "partition-visibility":"shared", "description":"'use-partition-level-config': Use configuration of authentication-log enable command; 'enable': Enable authentication logs for this template; 'disable': Disable authentication logs for this template; ", "enum":[ "use-partition-level-config", "enable", "disable" ], "optional":true }, "chain":{ "type":"array", "minItems":1, "items":{ "type":"object" }, "uniqueItems":true, "array":[ { "properties":{ "chain-server":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":63, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/server/ldap/instance", "not-list":[ "service-group", "chain-sg" ], "description":"Specify authentication server (Specify authentication server template name)" }, "chain-server-priority":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "default":3, "partition-visibility":"shared", "description":"Set server priority, higher the number higher the priority. Default is 3. (Chain server priority, higher the number higher the priority. Default is 3.)" }, "chain-sg":{ "type":"string", "format":"string-rlx", "minLength":1, "maxLength":127, "partition-visibility":"shared", "$ref":"/axapi/v3/aam/authentication/service-group", "not":"chain-server", "description":"Bind an authentication service group to this template (Specify authentication service group name)" }, "chain-sg-priority":{ "type":"number", "format":"number", "minimum":1, "maximum":5, "default":3, "partition-visibility":"shared", "description":"Set service-group priority, higher the number higher the priority. Default is 3. (Chain service-group priority, higher the number higher the priority. Default is 3.)" } } } ] }, "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 } }, "required":[ "name" ] } ] } } }