.. _aam_authentication_relay_ws_federation:

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

WS-Federation Authentication Relay


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

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

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

	 **Object Key(s)**                     *name*

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

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

	                                       

	 **Element Name**                      ws-federation

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

	 **Element Attributes**                ws-federation_attributes

	 **Partition Visibility**              shared

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

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



.. raw:: html

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


:ref:`65_ws-federation_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/aam_authentication_relay_ws_federation_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/aam/authentication/relay/ws-federation



.. raw:: html

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


:ref:`65_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}



.. raw:: html

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


:ref:`65_ws-federation_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/aam_authentication_relay_ws_federation_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/aam/authentication/relay/ws-federation



.. raw:: html

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


:ref:`65_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}



.. raw:: html

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


:ref:`65_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}



.. raw:: html

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


:ref:`65_ws-federation_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/aam_authentication_relay_ws_federation_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/aam/authentication/relay/ws-federation



.. raw:: html

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


:ref:`65_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}



.. raw:: html

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


:ref:`65_ws-federation_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/aam_authentication_relay_ws_federation_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _65_ws-federation_list:

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


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

        ws-federation-list : [

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

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

             ...

         ]

.. _65_ws-federation_attributes:

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

    **application-server**

        **Description** 'sharepoint': Microsoft SharePoint; 'exchange-owa': Microsoft Exchange OWA; 

        **Type:** string

        **Supported Values:** sharepoint, exchange-owa

    **authentication-uri**

        **Description** Specify WS-Federation relay URI, default is /_trust/

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **name**

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

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **packet-capture-template**

        **Description** Name of the packet capture template to be bind with this object

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/aam-auth-relay-ws-fed-tmpl <visibility_packet_capture_object_templates_aam_auth_relay_ws_fed_tmpl>`

    **sampling-enable**

        **Type:** List

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _65_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'request': Request; 'success': Success; 'failure': Failure; 

        **Type:** string

        **Supported Values:** all, request, success, failure