.. _aam_authentication_relay_http_basic_instance:

aam authentication relay http-basic instance
============================================

HTTP Basic Authentication Relay instance


instance Specification
----------------------

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

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

	 **Collection Name**                   :ref:`44_instance_list`

	 **Collection URI**                    /axapi/v3/aam/authentication/relay/http-basic/instance

	                                       

	 **Element Name**                      instance

	 **Element URI**                       /axapi/v3/aam/authentication/relay/http-basic/instance/{name}

	 **Element Attributes**                instance_attributes

	 **Statistics Data URI**               /axapi/v3/aam/authentication/relay/http-basic/instance/{name}/stats

	 **Schema**                             :download:`instance schema <aam-authentication-relay-http-basic-instance/aam-authentication-relay-http-basic-instance.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/http-basic/instance



.. raw:: html

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


:ref:`44_instance_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/http-basic/instance



.. raw:: html

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


:ref:`44_instance_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/http-basic/instance/{name}



.. raw:: html

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


:ref:`44_instance_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/http-basic/instance



.. raw:: html

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


:ref:`44_instance_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/http-basic/instance/{name}



.. raw:: html

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


:ref:`44_instance_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/http-basic/instance/{name}



.. raw:: html

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


:ref:`44_instance_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/http-basic/instance



.. raw:: html

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


:ref:`44_instance_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/http-basic/instance/{name}



.. raw:: html

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


:ref:`44_instance_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _44_instance_list:

instance-list
-------------


    instance-list is **JSON List** of :ref:`44_instance_attributes` 

        instance-list : [

             { :ref:`44_instance_attributes` },

             { :ref:`44_instance_attributes` },

             ...

         ]

.. _44_instance_attributes:

instance attributes
-------------------

    **domain**

        **Description** Specify user domain, default is null

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

    **domain-format**

        **Description** 'user-principal-name': Append domain with User Principal Name format. (e.g. user@domain); 'down-level-logon-name': Append domain with Down-Level Logon Name format. (e.g. domain\user); 

        **Type:** string

        **Supported Values:** user-principal-name, down-level-logon-name

        **Default:** down-level-logon-name

    **name**

        **Description** Specify HTTP basic authentication relay name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **packet-capture-template**

        **Description** Name of the packet capture template to be bind with this object

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/aam-auth-relay-hbase-inst-tmpl <visibility_packet_capture_object_templates_aam_auth_relay_hbase_inst_tmpl>`

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _44_sampling-enable:

sampling-enable
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'success': Success; 'no-creds': No Credential; 'bad-req': Bad Request; 'unauth': Unauthorized; 'forbidden': Forbidden; 'not-found': Not Found; 'server-error': Internal Server Error; 'unavailable': Service Unavailable; 

        **Type:** string

        **Supported Values:** all, success, no-creds, bad-req, unauth, forbidden, not-found, server-error, unavailable

.. _44_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - bad-req
      - 8
      - Bad Request

   *  - 
      - unavailable
      - 8
      - Service Unavailable

   *  - 
      - success
      - 8
      - Success

   *  - 
      - forbidden
      - 8
      - Forbidden

   *  - 
      - no-creds
      - 8
      - No Credential

   *  - 
      - server-error
      - 8
      - Internal Server Error

   *  - 
      - not-found
      - 8
      - Not Found

   *  - 
      - unauth
      - 8
      - Unauthorized