.. _aam_authentication_captcha:

aam authentication captcha
==========================

CAPTCHA Profile


captcha Specification
---------------------

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

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

	 **Element Name**                      captcha

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

	 **Element Attributes**                captcha_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/aam/authentication/captcha/stats

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



.. raw:: html

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


:ref:`15_captcha_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/aam_authentication_captcha_POST.txt
   :literal:




.. raw:: html

   </div></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/captcha



.. raw:: html

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


:ref:`15_captcha_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/aam_authentication_captcha_GET.txt
   :literal:




.. raw:: html

   </div></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/captcha



.. raw:: html

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


:ref:`15_captcha_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/captcha



.. raw:: html

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


:ref:`15_captcha_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/captcha



.. raw:: html

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


:ref:`15_captcha_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/aam_authentication_captcha_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _15_captcha_attributes:

captcha attributes
------------------

    **instance-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/aam/authentication/captcha/instance/{name} <aam_authentication_captcha_instance>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _15_instance-list:

instance-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **client-ip-param-name**

        **Description** Specify client ip parameter name used in API (Set parameter name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **encrypted**

        **Description** Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

    **method**

        **Description** 'POST': API uses POST method; 'GET': API uses GET method; 

        **Type:** string

        **Supported Values:** POST, GET

        **Default:** POST

    **name**

        **Description** Specify captcha profile name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **resp-error-code-field-name**

        **Description** Specify error code field name used in JSON response (Set field name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **resp-result-field-name**

        **Description** Specify result field name used in JSON response (Set field name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **secret-key**

        **Description** Specify secret key

        **Type:** boolean

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

        **Default:** 0

    **secret-key-param-name**

        **Description** Specify secret key parameter name used in API (Set parameter name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **secret-key-string**

        **Description** Secret key string

        **Type:** string

        **Format:** password

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **send-client-ip**

        **Description** Send client IP address in API

        **Type:** boolean

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

        **Default:** 0

    **timeout**

        **Description** Specify timeout for verify API response (Specify timeout value, default is 10 seconds)

        **Type:** number

        **Range:** 1-255

        **Default:** 10

    **token-param-name**

        **Description** Specify token parameter name used in API (Set parameter name)

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **url**

        **Description** Specify verify API URL, default scheme is https

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