aam authentication logon form-based¶
Form-based Authentication Logon
form-based Specification¶
Type Collection Object Key(s) name Collection Name form-based-list Collection URI /axapi/v3/aam/authentication/logon/form-based Element Name form-based Element URI /axapi/v3/aam/authentication/logon/form-based/{name} Element Attributes form-based_attributes Schema form-based schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/aam/authentication/logon/form-based | ||
Create List | POST | /axapi/v3/aam/authentication/logon/form-based | ||
Get Object | GET | /axapi/v3/aam/authentication/logon/form-based/{name} | ||
Get List | GET | /axapi/v3/aam/authentication/logon/form-based | ||
Modify Object | POST | /axapi/v3/aam/authentication/logon/form-based/{name} | ||
Replace Object | PUT | /axapi/v3/aam/authentication/logon/form-based/{name} | ||
Replace List | PUT | /axapi/v3/aam/authentication/logon/form-based | ||
Delete Object | DELETE | /axapi/v3/aam/authentication/logon/form-based/{name} |
form-based-list¶
form-based-list is JSON List of form-based attributes
form-based-list : [
]
form-based attributes¶
account-lock
Description Lock the account when the failed logon attempts is exceeded
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
challenge-variable
Description Specify challenge variable name in form submission
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
cp-page-cfg
Description: cp-page-cfg is a JSON Block. Please see below for cp-page-cfg
Type: Object
duration
Description The time an account remains locked in seconds (default 1800)
Type: number
Range: 1-86400
Default: 1800
logon-page-cfg
Description: logon-page-cfg is a JSON Block. Please see below for logon-page-cfg
Type: Object
name
Description Specify form-based authentication logon name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
new-pin-variable
Description Specify new-pin variable name in form submission
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
next-token-variable
Description Specify next-token variable name in form submission
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
notify-cp-page-cfg
Description: notify-cp-page-cfg is a JSON Block. Please see below for notify-cp-page-cfg
Type: Object
portal
Description: portal is a JSON Block. Please see below for portal
Type: Object
retry
Description Maximum number of consecutive failed logon attempts (default 3)
Type: number
Range: 1-32
Default: 3
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
notify-cp-page-cfg¶
Specification Type object notifychangepassword-change-url
Description Specify change password action url for notifychangepassword form
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
notifychangepassword-continue-url
Description Specify continue action url for notifychangepassword form
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
portal¶
Specification Type object challenge-page
Description Specify challenge page name for RSA-RADIUS
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: challenge-page new-pin-page and next-token-page are mutually exclusive
changepasswordpage
Description Specify change password page name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
default-portal
Description Use default portal
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: default-portal and portal-name are mutually exclusive
failpage
Description Specify logon fail page name (portal fail page name)
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
logon
Description Specify logon page name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
new-pin-page
Description Specify new PIN page name for RSA-RADIUS
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: new-pin-page and challenge-page are mutually exclusive
next-token-page
Description Specify next token page name for RSA-RADIUS
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: next-token-page and challenge-page are mutually exclusive
notifychangepasswordpage
Description Specify change password notification page name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
portal-name
Description Specify portal name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: portal-name and default-portal are mutually exclusive
logon-page-cfg¶
Specification Type object action-url
Description Specify form submission action url
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
authz-failure-message
Description Specify authorization failure message shown in logon page (Specify error string, default is “Authorization failed. Please contact your system administrator.”)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
captcha-variable
Description Specify captcha variable name in form submission
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
disable-change-password-link
Description Don’t display change password link on logon page forcibly even backend authentication server supports it (LDAP or Kerberos)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
login-failure-message
Description Specify login failure message shown in logon page (Specify error string, default is “Invalid username or password. Please try again.”)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
passcode-variable
Description Specify passcode variable name in form submission
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
password-variable
Description Specify password variable name in form submission
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
username-variable
Description Specify username variable name in form submission
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
cp-page-cfg¶
Specification Type object changepassword-url
Description Specify changepassword form submission action url (changepassword action url)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
cp-cfm-pwd-enum
Description ‘changepassword-password-confirm-variable’: Specify password confirm variable name in form submission;
Type: string
Supported Values: changepassword-password-confirm-variable
cp-cfm-pwd-var
Description Specify password confirm variable name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
cp-new-pwd-enum
Description ‘changepassword-new-password-variable’: Specify new password variable name in form submission;
Type: string
Supported Values: changepassword-new-password-variable
cp-new-pwd-var
Description Specify new password variable name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
cp-old-pwd-enum
Description ‘changepassword-old-password-variable’: Specify old password variable name in form submission;
Type: string
Supported Values: changepassword-old-password-variable
cp-old-pwd-var
Description Specify old password variable name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
cp-user-enum
Description ‘changepassword-username-variable’: Specify username variable name in form submission;
Type: string
Supported Values: changepassword-username-variable
cp-user-var
Description Specify username variable name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters