aam authentication logon form-based

Form-based Authentication Logon

This object allows you to configure your Form-based logon portal. The Logon Portal uses a set of web pages to collect end-user credentials. For authentication, ACOS sends the credentials from the end-user to a backend AAA server.

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 schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/aam/authentication/logon/form-based/

form-based Attributes

Create List

POST

/axapi/v3/aam/authentication/logon/form-based/

form-based Attributes

Get Object

GET

/axapi/v3/aam/authentication/logon/form-based/{name}

form-based Attributes

Get List

GET

/axapi/v3/aam/authentication/logon/form-based/

form-based-list

Modify Object

POST

/axapi/v3/aam/authentication/logon/form-based/{name}

form-based Attributes

Replace Object

PUT

/axapi/v3/aam/authentication/logon/form-based/{name}

form-based Attributes

Replace List

PUT

/axapi/v3/aam/authentication/logon/form-based/

form-based-list

Delete Object

DELETE

/axapi/v3/aam/authentication/logon/form-based/{name}

form-based Attributes

form-based-list

form-based-list is JSON List of form-based Attributes

form-based-list : [

form-based Attributes

cp-page-cfg

Description: cp-page-cfg is a JSON Block . Please see below for cp-page-cfg

Type: Object

logon-page-cfg

Description: logon-page-cfg is a JSON Block . Please see below for logon-page-cfg

Type: Object

name

Description: Specify a form-based logon name.
Sent by ACOS to client in response for request to secure services.

Type: string

Required: Yes

new-pin-variable

Description: Specify a new PIN associated with the form submission.

Type: string

Format: string-rlx

next-token-variable

Description: Specify the next-token name associated with the form submission.

Type: string

Format: string-rlx

portal

Description: portal is a JSON Block . Please see below for portal

Type: Object

retry

Description: Specify the maximum number of failure retries allowed for a form submission.

Type: number

Range: 1-32

Default: 3

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

portal

Specification
Type object

changepasswordpage

Description: Specify Change Password information. Enter a value for the maximum number of retries allowed.
Password change is sent by ACOS to the client to allow password change, if the client username is found on LDAP server but the password is expired.

Type: string

Format: string-rlx

default-portal

Description: Specify the default portal.
The default portal, which includes a logon page, a logon fail page, and a Change Password page is provided. You can choose to use default portal as the logon portal and configure the look and feel of the default form pages and limit the size of HTML files and other image files.

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 details. Enter a value for the maximum number of allowed retries after a logon failure.
A logon failure is sent by ACOS to the client if authentication fails.

Type: string

Format: string-rlx

logon

Description: Specify a page name for a configured form-based logon portal profile.

Type: string

new-pin-page

Description: Specify a new name for the PIN page of a form-based portal RSA_RADIUS.

Type: string

Format: string-rlx

next-token-page

Description: Specify a name for the token page in building a RSA-RADIUS profile.

Type: string

Format: string-rlx

portal-name

Description: Specify a name for a form-based portal profile.

Type: string

Mutual Exclusion: portal-name and default-portal are mutually exclusive

logon-page-cfg

Specification
Type object

action-url

Description: Change how the logon form-based submission action URL is displayed.

Type: string

Format: string-rlx

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

login-failure-message

Description: Specify a new login failure message shown on logon page. Enter a value for the maximum number of retries allowed.

Type: string

Format: string-rlx

passcode-variable

Description: Specify passcode variable name in form submission

Type: string

Format: string-rlx

password-variable

Description: Specify a new password variable name to be used in the form submission.

Type: string

Format: string-rlx

username-variable

Description: Specify a new username variable to be used in the submission form.

Type: string

Format: string-rlx

cp-page-cfg

Specification
Type object

changepassword-url

Description: Change how the Change Password submission action URL is displayed. Enter maximum number of retries allowed.

Type: string

Format: string-rlx

cp-cfm-pwd-enum

Description: Specify the variable of confirmed password field on the Change Password page.

Type: string

Supported Values: changepassword-password-confirm-variable

cp-cfm-pwd-var

Description: Specify the new password associated with the variable name on the Change Password page.

Type: string

Format: string-rlx

cp-new-pwd-enum

Description: Specify the variable of new password field on the Change Password page.

Type: string

Supported Values: changepassword-new-password-variable

cp-new-pwd-var

Description: Specify the new password associated with the variable name on the Change Password page.

Type: string

Format: string-rlx

cp-old-pwd-enum

Description: Specify the variable name of the password field on the Change Password page.

Type: string

Supported Values: changepassword-old-password-variable

cp-old-pwd-var

Description: Specify the old password associated with the variable name on the Change Password page.

Type: string

Format: string-rlx

cp-user-enum

Description: Specify a new Change Password variable username. Enter maximum number of retries allowed.

Type: string

Supported Values: changepassword-username-variable

cp-user-var

Description: Specify a new username on the client’s Change Password page. The username length is 1-63.

Type: string

Format: string-rlx