.. _debug_auth:

debug auth
==========

Debug authentication


auth Specification
------------------

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

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

	 **Element Name**                      auth

	 **Element URI**                       /axapi/v3/debug/auth

	 **Element Attributes**                auth_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`1283_auth_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1283_auth_attributes:

auth attributes
---------------

    **authd**

        **Description** enable detail authd log

        **Type:** boolean

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

        **Default:** 0

    **client-addr**

        **Description** Filter SAML logs by client IP address

        **Type:** string

        **Format:** ipv4-address

    **level**

        **Description** '1': Diagnose Problems; '2': Detail packet flow; 

        **Type:** string

        **Supported Values:** 1, 2

    **saml**

        **Description** Enable debug SAML authentication logs

        **Type:** boolean

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

        **Default:** 0

    **saml-sp**

        **Description** Filter SAML logs by SAML service provider name (SAML SP name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **username**

        **Description** Show the logs of specific username (User name)

        **Type:** string

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **virtual-server**

        **Description** Show the logs of specific virtual-server (Virtual-server name)

        **Type:** string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters