.. _aam_authentication_file:

aam authentication file
=======================




file Specification
------------------

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

	===================================== ================================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      file

	 **Element URI**                       /axapi/v3/aam/authentication/file

	 **Element Attributes**                file_attributes

	 **Partition Visibility**              shared

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


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/aam/authentication/file



.. raw:: html

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


file_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _20_file_attributes:

file attributes
---------------

    **portal**

        **Description:** portal is a **JSON Block**.  Please see below for :ref:`20_portal` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/aam/authentication/file/portal <aam_authentication_file_portal>`

    **portal-image**

        **Description:** portal-image is a **JSON Block**.  Please see below for :ref:`20_portal-image` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/aam/authentication/file/portal-image <aam_authentication_file_portal_image>`

.. _20_portal:

portal
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _20_portal-image:

portal-image
^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters