.. _aam_authentication_relay_form_based_instance_request_uri:

aam authentication relay form-based instance request-uri
========================================================

URI of authentication web page


request-uri Specification
-------------------------

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

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

	 **Object Key(s)**                     *match-type, uri*

	 **Collection Name**                   :ref:`46_request-uri_list`

	 **Collection URI**                    /axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri

	                                       

	 **Element Name**                      request-uri

	 **Element URI**                       /axapi/v3/aam/authentication/relay/form-based/instance/{name}/request-uri/{match-type}+{uri}

	 **Element Attributes**                request-uri_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`request-uri schema <aam-authentication-relay-form-based-instance-request-uri/aam-authentication-relay-form-based-instance-request-uri.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/form-based/instance/{name}/request-uri



.. raw:: html

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


:ref:`46_request-uri_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/relay/form-based/instance/{name}/request-uri



.. raw:: html

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


:ref:`46_request-uri_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/form-based/instance/{name}/request-uri/{match-type}+{uri}



.. raw:: html

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


:ref:`46_request-uri_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/relay/form-based/instance/{name}/request-uri



.. raw:: html

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


:ref:`46_request-uri_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/form-based/instance/{name}/request-uri/{match-type}+{uri}



.. raw:: html

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


:ref:`46_request-uri_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/form-based/instance/{name}/request-uri/{match-type}+{uri}



.. raw:: html

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


:ref:`46_request-uri_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/relay/form-based/instance/{name}/request-uri



.. raw:: html

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


:ref:`46_request-uri_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/form-based/instance/{name}/request-uri/{match-type}+{uri}



.. raw:: html

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


:ref:`46_request-uri_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _46_request-uri_list:

request-uri-list
----------------


    request-uri-list is **JSON List** of :ref:`46_request-uri_attributes` 

        request-uri-list : [

             { :ref:`46_request-uri_attributes` },

             { :ref:`46_request-uri_attributes` },

             ...

         ]

.. _46_request-uri_attributes:

request-uri attributes
----------------------

    **action-uri**

        **Description** Specify the action-URI

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **cookie**

        **Description:** cookie is a **JSON Block**.  Please see below for :ref:`46_cookie` 

        **Type:** Object

    **domain-variable**

        **Description** Specify domain variable name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **match-type**

        **Description** 'equals': URI exactly matches the string; 'contains': URI string contains another sub string; 'starts-with': URI string starts with sub string; 'ends-with': URI string ends with sub string; 

        **Type:** string

        **Supported Values:** equals, contains, starts-with, ends-with

    **max-packet-collect-size**

        **Description** Specify the max packet collection size in bytes, default is 1MB

        **Type:** number

        **Range:** 1024-2097152

        **Default:** 1048576

    **other-variables**

        **Description** Specify other variables (n1=v1&n2=v2) in form relay

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **password-variable**

        **Description** Specify password variable name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **uri**

        **Description** Specify request URI

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **user-tag**

        **Description** Customized tag

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **user-variable**

        **Description** Specify username variable name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _46_cookie:

cookie
^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **cookie-value**

        **Description:** cookie-value is a **JSON Block**.  Please see below for :ref:`46_cookie_cookie-value` 

        **Type:** Object

.. _46_cookie_cookie-value:

cookie_cookie-value
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **cookie-value**

        **Description** Specify cookie in POST packet

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters