.. _ntp_auth_key:

ntp auth-key
============

authentication key


auth-key Specification
----------------------

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

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

	 **Object Key(s)**                     *key*

	 **Collection Name**                   :ref:`2386_auth-key_list`

	 **Collection URI**                    /axapi/v3/ntp/auth-key

	                                       

	 **Element Name**                      auth-key

	 **Element URI**                       /axapi/v3/ntp/auth-key/{key}

	 **Element Attributes**                auth-key_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2386_auth-key_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/ntp_auth_key_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/ntp/auth-key



.. raw:: html

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


:ref:`2386_auth-key_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/ntp/auth-key/{key}



.. raw:: html

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


:ref:`2386_auth-key_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/ntp_auth_key_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/ntp/auth-key



.. raw:: html

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


:ref:`2386_auth-key_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/ntp/auth-key/{key}



.. raw:: html

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


:ref:`2386_auth-key_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/ntp/auth-key/{key}



.. raw:: html

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


:ref:`2386_auth-key_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/ntp_auth_key_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/ntp/auth-key



.. raw:: html

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


:ref:`2386_auth-key_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/ntp/auth-key/{key}



.. raw:: html

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


:ref:`2386_auth-key_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/ntp_auth_key_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2386_auth-key_list:

auth-key-list
-------------


    auth-key-list is **JSON List** of :ref:`2386_auth-key_attributes` 

        auth-key-list : [

             { :ref:`2386_auth-key_attributes` },

             { :ref:`2386_auth-key_attributes` },

             ...

         ]

.. _2386_auth-key_attributes:

auth-key attributes
-------------------

    **alg-type**

        **Description** 'M': encryption using MD5; 'SHA': encryption using SHA; 'SHA1': encryption using SHA1; 

        **Type:** string

        **Supported Values:** M, SHA, SHA1

    **asc-key**

        **Description** 

        **Type:** string

        **Format:** password

        **Maximum Length:** 20 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** asc-key and hex-key are mutually exclusive

    **encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

        **Mutual Exclusion:** encrypted and hex-encrypted are mutually exclusive

    **hex-encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

        **Mutual Exclusion:** hex-encrypted and encrypted are mutually exclusive

    **hex-key**

        **Description** 

        **Type:** string

        **Format:** password

        **Maximum Length:** 40 characters

        **Maximum Length:** 21 characters

        **Mutual Exclusion:** hex-key and asc-key are mutually exclusive

    **key**

        **Description** authentication key

        **Type:** number

        **Range:** 1-65535

    **key-type**

        **Description** 'ascii': key string in ASCII form; 'hex': key string in hex form; 

        **Type:** string

        **Supported Values:** ascii, hex

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters