.. _aam_authentication_session:

aam authentication session
==========================




session Specification
---------------------

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

	 **Element Name**                      session

	 **Element URI**                       /axapi/v3/aam/authentication/session

	 **Element Attributes**                session_attributes

	 **Operational Data URI**              /axapi/v3/aam/authentication/session/oper

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


Create Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/aam/authentication/session



.. raw:: html

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


:ref:`1653_session_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/session



.. raw:: html

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


:ref:`1653_session_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/aam/authentication/session



.. raw:: html

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


:ref:`1653_session_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/session



.. raw:: html

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


:ref:`1653_session_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/aam/authentication/session



.. raw:: html

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


:ref:`1653_session_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1653_session_attributes:

session attributes
------------------

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1653_oper_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - username
      - string
      - username

   *  - 
      - cmd-type
      - enum
      -  Output contains one of the following values: - sess-only, attr-only, sess-attr

   *  - 
      - partition
      - string
      - partition

   *  - 
      - vserver
      - string
      - vserver

   *  - 
      - ipv4
      - string
      - ipv4

   *  - 
      - ipv6
      - string
      - ipv6

   *  - 
      - session-list
      - 
      - session-list