aam authentication portal logon¶
Logon page configuration
logon Specification¶
Parameter Value Type Configuration Resource Element Name logon Element URI /axapi/v3/aam/authentication/portal/{name}/logon Element Attributes logon_attributes Partition Visibility shared Schema logon schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/aam/authentication/portal/{name}/logon | ||
Get Object | GET | /axapi/v3/aam/authentication/portal/{name}/logon | ||
Modify Object | POST | /axapi/v3/aam/authentication/portal/{name}/logon | ||
Replace Object | PUT | /axapi/v3/aam/authentication/portal/{name}/logon | ||
Delete Object | DELETE | /axapi/v3/aam/authentication/portal/{name}/logon |
logon attributes¶
action-url
Description Specify form action URL in default logon page (Default: /logon.fo)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
background
Description: background is a JSON Block. Please see below for background
Type: Object
captcha-type
Description ‘reCAPTCHAv2-checkbox’: Google reCAPTCHAv2 Checkbox; ‘reCAPTCHAv2-invisible’: Google reCAPTCHAv2 Invisible; ‘reCAPTCHAv3’: Google reCAPTCHAv3;
Type: string
Supported Values: reCAPTCHAv2-checkbox, reCAPTCHAv2-invisible, reCAPTCHAv3
enable-CAPTCHA
Description Enable CAPTCHA in deafult logon page
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enable-passcode
Description Enable passcode field in default logon page
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)fail-msg-cfg
Description: fail-msg-cfg is a JSON Block. Please see below for fail-msg-cfg
Type: Object
passcode-cfg
Description: passcode-cfg is a JSON Block. Please see below for passcode-cfg
Type: Object
passcode-var
Description Specify passcode variable name in default logon page (Default: passcode)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
password-cfg
Description: password-cfg is a JSON Block. Please see below for password-cfg
Type: Object
password-var
Description Specify password variable name in default logon page (Default: pwd)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
reCAPTCHA-cfg
Description: reCAPTCHA-cfg is a JSON Block. Please see below for reCAPTCHA-cfg
Type: Object
site-key-string
Description Site key string
Type: string
Format: password
Maximum Length: 127 characters
Maximum Length: 1 characters
submit-text
Description Specify submit button text in default logon page (Default: Log In)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
username-cfg
Description: username-cfg is a JSON Block. Please see below for username-cfg
Type: Object
username-var
Description Specify username variable name in default logon page (Default: user)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
passcode-cfg¶
Specification Value Type object passcode
Description Configure passcode text in default logon page
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
passcode-color
Description Specify font color (Default: black)
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
passcode-color-name
Description ‘aqua’: aqua; ‘black’: black; ‘blue’: blue; ‘fuchsia’: fuchsia; ‘gray’: gray; ‘green’: green; ‘lime’: lime; ‘maroon’: maroon; ‘navy’: navy; ‘olive’: olive; ‘orange’: orange; ‘purple’: purple; ‘red’: red; ‘silver’: silver; ‘teal’: teal; ‘white’: white; ‘yellow’: yellow;
Type: string
Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow
Default: black
Mutual Exclusion: passcode-color-name and passcode-color-value are mutually exclusive
passcode-color-value
Description Specify 6-digit HEX color value
Type: string
Maximum Length: 6 characters
Maximum Length: 6 characters
Mutual Exclusion: passcode-color-value and passcode-color-name are mutually exclusive
passcode-face
Description ‘Arial’: Arial; ‘Courier_New’: Courier New; ‘Georgia’: Georgia; ‘Times_New_Roman’: Times New Roman; ‘Verdana’: Verdana;
Type: string
Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana
Default: Arial
Mutual Exclusion: passcode-face and passcode-font-custom are mutually exclusive
passcode-font
Description Sepcify font (Default: Arial)
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
passcode-font-custom
Description Specify custom font
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: passcode-font-custom and passcode-face are mutually exclusive
passcode-size
Description Specify font size (Default: 3)
Type: number
Range: 1-7
Default: 3
passcode-text
Description Specify passcode text (Default: Passcode)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
reCAPTCHA-cfg¶
Specification Value Type object reCAPTCHA-action
Description Specify reCAPTCHA action (Specify action string, only accept alphanumeric, underscore, and slash (Default: A10_DEFAULT_LOGON))
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Default: A10_DEFAULT_LOGON
reCAPTCHA-badge
Description ‘bottom-left’: bottom left corner; ‘bottom-right’: bottom right corner;
Type: string
Supported Values: bottom-left, bottom-right
Default: bottom-right
reCAPTCHA-size
Description ‘normal’: normal size; ‘compact’: compact size;
Type: string
Supported Values: normal, compact
Default: normal
reCAPTCHA-theme
Description ‘light’: light theme; ‘dark’: dark theme;
Type: string
Supported Values: light, dark
Default: light
background¶
Specification Value Type object bgcolor-name
Description ‘aqua’: aqua; ‘black’: black; ‘blue’: blue; ‘fuchsia’: fuchsia; ‘gray’: gray; ‘green’: green; ‘lime’: lime; ‘maroon’: maroon; ‘navy’: navy; ‘olive’: olive; ‘orange’: orange; ‘purple’: purple; ‘red’: red; ‘silver’: silver; ‘teal’: teal; ‘white’: white; ‘yellow’: yellow;
Type: string
Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow
Default: white
Mutual Exclusion: bgcolor-name, bgfile, and bgcolor-value are mutually exclusive
bgcolor-value
Description Specify 6-digit HEX color value
Type: string
Maximum Length: 6 characters
Maximum Length: 6 characters
Mutual Exclusion: bgcolor-value, bgfile, and bgcolor-name are mutually exclusive
bgfile
Description Specify background image filename
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: bgfile, bgcolor-name, and bgcolor-value are mutually exclusive
bgstyle
Description ‘tile’: Tile; ‘stretch’: Stretch; ‘fit’: Fit;
Type: string
Supported Values: tile, stretch, fit
Default: tile
fail-msg-cfg¶
Specification Value Type object authz-fail-msg
Description Configure authorization failure message in default logon page, its text attributes follow fail-msg’s (Specify authorization failure message (Default: Authorization failed. Please contact your system administrator.))
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
fail-color
Description Specify font color (Default: red)
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
fail-color-name
Description ‘aqua’: aqua; ‘black’: black; ‘blue’: blue; ‘fuchsia’: fuchsia; ‘gray’: gray; ‘green’: green; ‘lime’: lime; ‘maroon’: maroon; ‘navy’: navy; ‘olive’: olive; ‘orange’: orange; ‘purple’: purple; ‘red’: red; ‘silver’: silver; ‘teal’: teal; ‘white’: white; ‘yellow’: yellow;
Type: string
Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow
Default: red
Mutual Exclusion: fail-color-name and fail-color-value are mutually exclusive
fail-color-value
Description Specify 6-digit HEX color value
Type: string
Maximum Length: 6 characters
Maximum Length: 6 characters
Mutual Exclusion: fail-color-value and fail-color-name are mutually exclusive
fail-face
Description ‘Arial’: Arial; ‘Courier_New’: Courier New; ‘Georgia’: Georgia; ‘Times_New_Roman’: Times New Roman; ‘Verdana’: Verdana;
Type: string
Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana
Default: Arial
Mutual Exclusion: fail-face and fail-font-custom are mutually exclusive
fail-font
Description Sepcify font (Default: Arial)
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
fail-font-custom
Description Specify custom font
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: fail-font-custom and fail-face are mutually exclusive
fail-msg
Description Configure login failure message in default logon page
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
fail-size
Description Specify font size (Default: 5)
Type: number
Range: 1-7
Default: 5
fail-text
Description Specify login failure message (Default: Invalid username or password. Please try again.)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
password-cfg¶
Specification Value Type object pass-color
Description Specify font color (Default: black)
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
pass-color-name
Description ‘aqua’: aqua; ‘black’: black; ‘blue’: blue; ‘fuchsia’: fuchsia; ‘gray’: gray; ‘green’: green; ‘lime’: lime; ‘maroon’: maroon; ‘navy’: navy; ‘olive’: olive; ‘orange’: orange; ‘purple’: purple; ‘red’: red; ‘silver’: silver; ‘teal’: teal; ‘white’: white; ‘yellow’: yellow;
Type: string
Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow
Default: black
Mutual Exclusion: pass-color-name and pass-color-value are mutually exclusive
pass-color-value
Description Specify 6-digit HEX color value
Type: string
Maximum Length: 6 characters
Maximum Length: 6 characters
Mutual Exclusion: pass-color-value and pass-color-name are mutually exclusive
pass-face
Description ‘Arial’: Arial; ‘Courier_New’: Courier New; ‘Georgia’: Georgia; ‘Times_New_Roman’: Times New Roman; ‘Verdana’: Verdana;
Type: string
Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana
Default: Arial
Mutual Exclusion: pass-face and pass-font-custom are mutually exclusive
pass-font
Description Sepcify font (Default: Arial)
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
pass-font-custom
Description Specify custom font
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: pass-font-custom and pass-face are mutually exclusive
pass-size
Description Specify font size (Default: 3)
Type: number
Range: 1-7
Default: 3
pass-text
Description Specify password text (Default: Password)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
password
Description Configure password text in default logon page
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
username-cfg¶
Specification Value Type object user-color
Description Specify font color (Default: black)
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
user-color-name
Description ‘aqua’: aqua; ‘black’: black; ‘blue’: blue; ‘fuchsia’: fuchsia; ‘gray’: gray; ‘green’: green; ‘lime’: lime; ‘maroon’: maroon; ‘navy’: navy; ‘olive’: olive; ‘orange’: orange; ‘purple’: purple; ‘red’: red; ‘silver’: silver; ‘teal’: teal; ‘white’: white; ‘yellow’: yellow;
Type: string
Supported Values: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, orange, purple, red, silver, teal, white, yellow
Default: black
Mutual Exclusion: user-color-name and user-color-value are mutually exclusive
user-color-value
Description Specify 6-digit HEX color value
Type: string
Maximum Length: 6 characters
Maximum Length: 6 characters
Mutual Exclusion: user-color-value and user-color-name are mutually exclusive
user-face
Description ‘Arial’: Arial; ‘Courier_New’: Courier New; ‘Georgia’: Georgia; ‘Times_New_Roman’: Times New Roman; ‘Verdana’: Verdana;
Type: string
Supported Values: Arial, Courier_New, Georgia, Times_New_Roman, Verdana
Default: Arial
Mutual Exclusion: user-face and user-font-custom are mutually exclusive
user-font
Description Sepcify font (Default: Arial)
Type: boolean
Supported Values: true, false, 1, 0
Default: 1
user-font-custom
Description Specify custom font
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: user-font-custom and user-face are mutually exclusive
user-size
Description Specify font size (Default: 3)
Type: number
Range: 1-7
Default: 3
user-text
Description Specify username text (Default: User Name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
username
Description Configure username text in default logon page
Type: boolean
Supported Values: true, false, 1, 0
Default: 0