.. _file_auth_portal_image:

file auth-portal-image
======================

Authentication portal image file information and management commands


auth-portal-image Specification
-------------------------------

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

	===================================== ===============================================================
	 **Type**                              *operational*

	 **Element Name**                      auth-portal-image

	 **Element URI**                       /axapi/v3/file/auth-portal-image

	 **Element Attributes**                auth-portal-image_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/file/auth-portal-image/oper

	 **Schema**                             :download:`auth-portal-image schema <file-auth-portal-image/file-auth-portal-image.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'>


EXECUTE Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/file/auth-portal-image



.. raw:: html

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


:ref:`1517_auth-portal-image_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1517_auth-portal-image_attributes:

auth-portal-image attributes
----------------------------

    **action**

        **Description** 'create': create; 'import': import; 'export': export; 'copy': copy; 'rename': rename; 'check': check; 'replace': replace; 'delete': delete; 

        **Type:** string

        **Supported Values:** create, import, export, copy, rename, check, replace, delete

    **dst-file**

        **Description** Destination file name for copy and rename action

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **file**

        **Description** Authentication portal image local file name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **file-handle**

        **Description** Full path of the uploaded file

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 255 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters