.. _admin_session:

admin-session
=============

Admin session management


admin-session Specification
---------------------------

	===================================== ======================================================
	===================================== ======================================================
	 **Type**                              *operational*

	 **Element Name**                      admin-session

	 **Element URI**                       /axapi/v3/admin-session

	 **Element Attributes**                admin-session_attributes

	 **Operational Data URI**              /axapi/v3/admin-session/oper

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


EXECUTE Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/admin-session



.. raw:: html

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


:ref:`152_admin-session_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _152_admin-session_attributes:

admin-session attributes
------------------------

    **all**

        **Description** Clear all admin sessions

        **Type:** boolean

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

        **Default:** 0

    **clear**

        **Description** clear admin session

        **Type:** boolean

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

        **Default:** 0

    **sid**

        **Description** Session ID

        **Type:** number

        **Range:** 0-2147483647

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _152_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - session-list
      - 
      - session-list