.. _aam_authentication_logon_http_authenticate_instance:

aam authentication logon http-authenticate instance
===================================================

HTTP-authenticate Logon


instance Specification
----------------------

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

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

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

	 **Collection Name**                   :ref:`29_instance_list`

	 **Collection URI**                    /axapi/v3/aam/authentication/logon/http-authenticate/instance

	                                       

	 **Element Name**                      instance

	 **Element URI**                       /axapi/v3/aam/authentication/logon/http-authenticate/instance/{name}

	 **Element Attributes**                instance_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/aam/authentication/logon/http-authenticate/instance/{name}/stats

	 **Schema**                             :download:`instance schema <aam-authentication-logon-http-authenticate-instance/aam-authentication-logon-http-authenticate-instance.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/http-authenticate/instance



.. raw:: html

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


:ref:`29_instance_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_http_authenticate_instance_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/http-authenticate/instance



.. raw:: html

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


:ref:`29_instance_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/http-authenticate/instance/{name}



.. raw:: html

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


:ref:`29_instance_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_http_authenticate_instance_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/http-authenticate/instance



.. raw:: html

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


:ref:`29_instance_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/http-authenticate/instance/{name}



.. raw:: html

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


:ref:`29_instance_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/http-authenticate/instance/{name}



.. raw:: html

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


:ref:`29_instance_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_http_authenticate_instance_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/http-authenticate/instance



.. raw:: html

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


:ref:`29_instance_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/http-authenticate/instance/{name}



.. raw:: html

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


:ref:`29_instance_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_http_authenticate_instance_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _29_instance_list:

instance-list
-------------


    instance-list is **JSON List** of :ref:`29_instance_attributes` 

        instance-list : [

             { :ref:`29_instance_attributes` },

             { :ref:`29_instance_attributes` },

             ...

         ]

.. _29_instance_attributes:

instance attributes
-------------------

    **account-lock**

        **Description** Lock the account when the failed logon attempts is exceeded

        **Type:** boolean

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

        **Default:** 0

    **auth-method**

        **Description:** auth-method is a **JSON Block**.  Please see below for :ref:`29_auth-method` 

        **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

    **name**

        **Description** Specify HTTP-Authenticate logon name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **packet-capture-template**

        **Description** Name of the packet capture template to be bind with this object

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/aam-auth-logon-http-ins-tmpl <visibility_packet_capture_object_templates_aam_auth_logon_http_ins_tmpl>`

    **retry**

        **Description** Maximum number of consecutive failed logon attempts (default 3)

        **Type:** number

        **Range:** 1-32

        **Default:** 3

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _29_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'spn_krb_request': SPN Kerberos Request; 'spn_krb_success': SPN Kerberos Success; 'spn_krb_faiure': SPN Kerberos Failure; 

        **Type:** string

        **Supported Values:** all, spn_krb_request, spn_krb_success, spn_krb_faiure

.. _29_auth-method:

auth-method
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **basic**

        **Description:** basic is a **JSON Block**.  Please see below for :ref:`29_auth-method_basic` 

        **Type:** Object

    **negotiate**

        **Description:** negotiate is a **JSON Block**.  Please see below for :ref:`29_auth-method_negotiate` 

        **Type:** Object

    **ntlm**

        **Description:** ntlm is a **JSON Block**.  Please see below for :ref:`29_auth-method_ntlm` 

        **Type:** Object

.. _29_auth-method_ntlm:

auth-method_ntlm
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **ntlm-enable**

        **Description** Enable NTLM logon

        **Type:** boolean

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

        **Default:** 0

.. _29_auth-method_negotiate:

auth-method_negotiate
^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **negotiate-enable**

        **Description** Enable SPENGO logon

        **Type:** boolean

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

        **Default:** 0

.. _29_auth-method_basic:

auth-method_basic
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **basic-enable**

        **Description** Enable Basic logon

        **Type:** boolean

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

        **Default:** 0

    **basic-realm**

        **Description** Specify realm for basic logon

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **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 and new-pin-page are mutually exclusive

    **challenge-response-form**

        **Description** Specify challenge-response form for RSA-RADIUS authentication

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **challenge-variable**

        **Description** Specify challenge variable name

        **Type:** string

        **Format:** string-rlx

        **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

    **new-pin-variable**

        **Description** Specify new PIN variable name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **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

    **next-token-variable**

        **Description** Specify next-token variable name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters