.. _aam_authentication_logon_form_based:

aam authentication logon form-based
===================================

Form-based Authentication Logon


form-based Specification
------------------------

	===================================== ===================================================================================
	 **Parameter**                         **Value** 

	===================================== ===================================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`27_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

	 **Partition Visibility**              shared

	 **Schema**                             :download:`form-based schema <aam-authentication-logon-form-based/aam-authentication-logon-form-based.txt>`
	===================================== ===================================================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`27_form-based_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/aam_authentication_logon_form_based_POST.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`27_form-based_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`27_form-based_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/aam_authentication_logon_form_based_GET.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`27_form-based_list`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`27_form-based_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`27_form-based_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/aam_authentication_logon_form_based_PUT.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`27_form-based_list`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`27_form-based_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/aam_authentication_logon_form_based_DELETE.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   </table>

.. _27_form-based_list:

form-based-list
---------------


    form-based-list is **JSON List** of :ref:`27_form-based_attributes` 

        form-based-list : [

             { :ref:`27_form-based_attributes` },

             { :ref:`27_form-based_attributes` },

             ...

         ]

.. _27_form-based_attributes:

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 :ref:`27_cp-page-cfg` 

        **Type:** Object

    **csp-support**

        **Description:** csp-support is a **JSON Block**.  Please see below for :ref:`27_csp-support` 

        **Type:** Object

    **duration**

        **Description** The time an account remains locked in seconds (default 1800)

        **Type:** number

        **Range:** 1-86400

        **Default:** 1800

    **hsts-timeout**

        **Description** Set HSTS policy expired timeout in seconds, 0 means to disable HSTS policy

        **Type:** number

        **Range:** 0-315360000

    **logon-page-cfg**

        **Description:** logon-page-cfg is a **JSON Block**.  Please see below for :ref:`27_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 :ref:`27_notify-cp-page-cfg` 

        **Type:** Object

    **portal**

        **Description:** portal is a **JSON Block**.  Please see below for :ref:`27_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

.. _27_csp-support:

csp-support
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **none**

        **Description** Set CSP frame-ancestors to none (also X-Frame-Options deny)

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

        **Mutual Exclusion:** none, self, and specificURI are mutually exclusive

    **optional-second-URI**

        **Description** Set optional second customized CSP URI

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **self**

        **Description** Set CSP frame-ancestors to self (also X-Frame-Options same-origin)

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

        **Mutual Exclusion:** self and none are mutually exclusive

    **specificURI**

        **Description** Set customized CSP frame-ancestors (maximum 2 URIs can be set)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** specificURI and none are mutually exclusive

.. _27_notify-cp-page-cfg:

notify-cp-page-cfg
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **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

.. _27_portal:

portal
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **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

.. _27_logon-page-cfg:

logon-page-cfg
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **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

.. _27_cp-page-cfg:

cp-page-cfg
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **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