.. _aam_authentication_saml_identity_provider:

aam authentication saml identity-provider
=========================================

Authentication identity provider


identity-provider Specification
-------------------------------

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

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

	 **Collection Name**                   :ref:`62_identity-provider_list`

	 **Collection URI**                    /axapi/v3/aam/authentication/saml/identity-provider

	                                       

	 **Element Name**                      identity-provider

	 **Element URI**                       /axapi/v3/aam/authentication/saml/identity-provider/{name}

	 **Element Attributes**                identity-provider_attributes

	 **Statistics Data URI**               /axapi/v3/aam/authentication/saml/identity-provider/{name}/stats

	 **Operational Data URI**              /axapi/v3/aam/authentication/saml/identity-provider/{name}/oper

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



.. raw:: html

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


:ref:`62_identity-provider_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/saml/identity-provider



.. raw:: html

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


:ref:`62_identity-provider_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/identity-provider/{name}



.. raw:: html

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


:ref:`62_identity-provider_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/saml/identity-provider



.. raw:: html

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


:ref:`62_identity-provider_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/saml/identity-provider/{name}



.. raw:: html

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


:ref:`62_identity-provider_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/identity-provider/{name}



.. raw:: html

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


:ref:`62_identity-provider_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/saml/identity-provider



.. raw:: html

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


:ref:`62_identity-provider_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/saml/identity-provider/{name}



.. raw:: html

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


:ref:`62_identity-provider_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _62_identity-provider_list:

identity-provider-list
----------------------


    identity-provider-list is **JSON List** of :ref:`62_identity-provider_attributes` 

        identity-provider-list : [

             { :ref:`62_identity-provider_attributes` },

             { :ref:`62_identity-provider_attributes` },

             ...

         ]

.. _62_identity-provider_attributes:

identity-provider attributes
----------------------------

    **metadata**

        **Description** URL of SAML identity provider's metadata file

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **name**

        **Description** SAML authentication identity provider name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **reload-interval**

        **Description** Specify URI metadata reload period (Specify URI metadata reload period in seconds, default is 28800)

        **Type:** number

        **Range:** 1-86400

        **Default:** 28800

    **reload-metadata**

        **Description** Reload IdP's metadata immediately

        **Type:** boolean

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

        **Default:** 0

    **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

.. _62_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - valid-status
      - 8
      - Valid IdP status or not

   *  - 
      - md-state
      - 8
      - Metadata State

   *  - 
      - md-update
      - 8
      - Metadata Update Success Count

   *  - 
      - acs-fail
      - 8
      - ACS Fail Count

   *  - 
      - acs-pass
      - 8
      - ACS Pass Count

   *  - 
      - acs-state
      - 8
      - ACS State

   *  - 
      - md-fail
      - 8
      - Metadata Update Fail Count

   *  - 
      - acs-req
      - 8
      - ACS Request Total Count

.. _62_oper_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - md
      - string
      - md

   *  - 
      - sso-list
      - 
      - sso-list

   *  - 
      - entity-id
      - string
      - entity-id

   *  - 
      - slo-list
      - 
      - slo-list

   *  - 
      - cert
      - string
      - cert

   *  - 
      - ars-list
      - 
      - ars-list

   *  - 
      - aqs-list
      - 
      - aqs-list