.. _authentication:

authentication
==============

Configure authentication feature


authentication Specification
----------------------------

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

	===================================== =======================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      authentication

	 **Element URI**                       /axapi/v3/authentication

	 **Element Attributes**                authentication_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`authentication schema <authentication/authentication.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/authentication



.. raw:: html

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


:ref:`187_authentication_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/authentication



.. raw:: html

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


:ref:`187_authentication_attributes`



.. 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/authentication



.. raw:: html

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


:ref:`187_authentication_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/authentication



.. raw:: html

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


:ref:`187_authentication_attributes`



.. 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/authentication



.. raw:: html

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


:ref:`187_authentication_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _187_authentication_attributes:

authentication attributes
-------------------------

    **console**

        **Description:** console is a **JSON Block**.  Please see below for :ref:`187_console` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/authentication/console <authentication_console>`

    **enable-cfg**

        **Description:** enable-cfg is a **JSON Block**.  Please see below for :ref:`187_enable-cfg` 

        **Type:** Object

    **login-cfg**

        **Description:** login-cfg is a **JSON Block**.  Please see below for :ref:`187_login-cfg` 

        **Type:** Object

    **mode-cfg**

        **Description:** mode-cfg is a **JSON Block**.  Please see below for :ref:`187_mode-cfg` 

        **Type:** Object

    **multiple-auth-reject**

        **Description** Multiple same user login reject

        **Type:** boolean

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

        **Default:** 0

    **type-cfg**

        **Description:** type-cfg is a **JSON Block**.  Please see below for :ref:`187_type-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _187_console:

console
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **type-cfg**

        **Description:** type-cfg is a **JSON Block**.  Please see below for :ref:`187_console_type-cfg` 

        **Type:** Object

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _187_console_type-cfg:

console_type-cfg
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **console-type**

        **Description** 

        **Type:** string

        **Format:** enum-list

    **type**

        **Description** The login authentication type

        **Type:** boolean

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

        **Default:** 0

.. _187_mode-cfg:

mode-cfg
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **mode**

        **Description** 'multiple': Multiple authentication mode. If an authentication method rejected, try next one; 'single': Single authentication mode. If an authentication method rejected, don't try next one; 

        **Type:** string

        **Supported Values:** multiple, single

        **Default:** single

.. _187_type-cfg:

type-cfg
^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **type**

        **Description** The login authentication type

        **Type:** string

        **Format:** enum-list

        **Default:** local

.. _187_login-cfg:

login-cfg
^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **local**

        **Description** Configure local user to enter privilege-mode

        **Type:** boolean

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

        **Default:** 0

    **privilege-mode**

        **Description** Configure to enter privilege-mode

        **Type:** boolean

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

        **Default:** 0

.. _187_enable-cfg:

enable-cfg
^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **enable-auth-type**

        **Description** The enable-password authentication type

        **Type:** string

        **Format:** enum-list

        **Default:** local