.. _aam_authentication_saml_global:

aam authentication saml global
==============================

Global SAML statistics


global Specification
--------------------

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

	 **Element Name**                      global

	 **Element URI**                       /axapi/v3/aam/authentication/saml/global

	 **Element Attributes**                global_attributes

	 **Statistics Data URI**               /axapi/v3/aam/authentication/saml/global/stats

	 **Schema**                             :download:`global schema <aam-authentication-saml-global/aam-authentication-saml-global.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/saml/global



.. raw:: html

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


:ref:`60_global_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/saml/global



.. raw:: html

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


:ref:`60_global_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/saml/global



.. raw:: html

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


:ref:`60_global_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/saml/global



.. raw:: html

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


:ref:`60_global_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/saml/global



.. raw:: html

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


:ref:`60_global_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _60_global_attributes:

global attributes
-----------------

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _60_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'requests-to-a10saml': Total Request to A10 SAML Service; 'responses-from-a10saml': Total Response from A10 SAML Service; 'sp-metadata-export-req': Total Metadata Export Request; 'sp-metadata-export-success': Toal Metadata Export Success; 'login-auth-req': Total Login Authentication Request; 'login-auth-resp': Total Login Authentication Response; 'acs-req': Total SAML Single-Sign-On Request; 'acs-success': Total SAML Single-Sign-On Success; 'acs-authz-fail': Total SAML Single-Sign-On Authorization Fail; 'acs-error': Total SAML Single-Sign-On Error; 'slo-req': Total Single Logout Request; 'slo-success': Total Single Logout Success; 'slo-error': Total Single Logout Error; 'sp-slo-req': Total SP-initiated Single Logout Request; 'glo-slo-success': Total Global Logout Success; 'loc-slo-success': Total Local Logout Success; 'par-slo-success': Total Partial Logout Success; 'relay-req': some help string; 'relay-success': some help string; 'relay-fail': some help string; 'relay-error': some help string; 'other-error': Total Other Error; 

        **Type:** string

        **Supported Values:** all, requests-to-a10saml, responses-from-a10saml, sp-metadata-export-req, sp-metadata-export-success, login-auth-req, login-auth-resp, acs-req, acs-success, acs-authz-fail, acs-error, slo-req, slo-success, slo-error, sp-slo-req, glo-slo-success, loc-slo-success, par-slo-success, relay-req, relay-success, relay-fail, relay-error, other-error

.. _60_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - slo-error
      - 8
      - Total Single Logout Error

   *  - 
      - relay-req
      - 8
      - some help string

   *  - 
      - sp-metadata-export-success
      - 8
      - Toal Metadata Export Success

   *  - 
      - par-slo-success
      - 8
      - Total Partial Logout Success

   *  - 
      - slo-success
      - 8
      - Total Single Logout Success

   *  - 
      - other-error
      - 8
      - Total Other Error

   *  - 
      - relay-fail
      - 8
      - some help string

   *  - 
      - glo-slo-success
      - 8
      - Total Global Logout Success

   *  - 
      - sp-slo-req
      - 8
      - Total SP-initiated Single Logout Request

   *  - 
      - responses-from-a10saml
      - 8
      - Total Response from A10 SAML Service

   *  - 
      - login-auth-req
      - 8
      - Total Login Authentication Request

   *  - 
      - relay-error
      - 8
      - some help string

   *  - 
      - acs-authz-fail
      - 8
      - Total SAML Single-Sign-On Authorization Fail

   *  - 
      - login-auth-resp
      - 8
      - Total Login Authentication Response

   *  - 
      - acs-success
      - 8
      - Total SAML Single-Sign-On Success

   *  - 
      - acs-req
      - 8
      - Total SAML Single-Sign-On Request

   *  - 
      - sp-metadata-export-req
      - 8
      - Total Metadata Export Request

   *  - 
      - relay-success
      - 8
      - some help string

   *  - 
      - slo-req
      - 8
      - Total Single Logout Request

   *  - 
      - loc-slo-success
      - 8
      - Total Local Logout Success

   *  - 
      - requests-to-a10saml
      - 8
      - Total Request to A10 SAML Service

   *  - 
      - acs-error
      - 8
      - Total SAML Single-Sign-On Error