.. _aam_authentication_relay_ws_federation_stats:

aam authentication relay ws-federation stats
============================================

Statistics for the object ws-federation


ws-federation Specification
---------------------------

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

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

	 **Collection Name**                   :ref:`64_ws-federation_list`

	 **Collection URI**                    /axapi/v3/aam/authentication/relay/ws-federation/{name}

	                                       

	 **Element Name**                      ws-federation

	 **Element URI**                       /axapi/v3/aam/authentication/relay/ws-federation/{name}/stats

	 **Element Attributes**                ws-federation_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`ws-federation schema <aam-authentication-relay-ws-federation-stats/aam-authentication-relay-ws-federation-stats.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/relay/ws-federation/{name}



.. raw:: html

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


:ref:`64_ws-federation_attributes`



.. raw:: html

   </td><td></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/aam/authentication/relay/ws-federation/{name}



.. raw:: html

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


:ref:`64_ws-federation_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/relay/ws-federation/{name}/stats



.. raw:: html

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


:ref:`64_ws-federation_attributes`



.. raw:: html

   </td><td></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/aam/authentication/relay/ws-federation/{name}



.. raw:: html

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


:ref:`64_ws-federation_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/aam/authentication/relay/ws-federation/{name}/stats



.. raw:: html

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


:ref:`64_ws-federation_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/relay/ws-federation/{name}/stats



.. raw:: html

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


:ref:`64_ws-federation_attributes`



.. raw:: html

   </td><td></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/aam/authentication/relay/ws-federation/{name}



.. raw:: html

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


:ref:`64_ws-federation_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/aam/authentication/relay/ws-federation/{name}/stats



.. raw:: html

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


:ref:`64_ws-federation_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _64_ws-federation_list:

ws-federation-list
------------------


    ws-federation-list is **JSON List** of :ref:`64_ws-federation_attributes` 

        ws-federation-list : [

             { :ref:`64_ws-federation_attributes` },

             { :ref:`64_ws-federation_attributes` },

             ...

         ]

.. _64_ws-federation_attributes:

ws-federation attributes
------------------------

    **name**

        **Description** Specify WS-Federation authentication relay name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **stats**

        **Description:** stats is a **JSON Block**.  Please see below for :ref:`64_stats` 

        **Type:** Object

.. _64_stats:

stats
^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **failure**

        **Description** Failure

        **Type:** number

        **Format:** counter

    **request**

        **Description** Request

        **Type:** number

        **Format:** counter

    **success**

        **Description** Success

        **Type:** number

        **Format:** counter