.. _aam_authentication_account:

aam authentication account
==========================

Authentication account configuration


account Specification
---------------------

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

	 **Element Name**                      account

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

	 **Element Attributes**                account_attributes

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

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



.. raw:: html

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


:ref:`9_account_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/account



.. raw:: html

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


:ref:`9_account_attributes`



.. 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/account



.. raw:: html

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


:ref:`9_account_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/account



.. raw:: html

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


:ref:`9_account_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/account



.. raw:: html

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


:ref:`9_account_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _9_account_attributes:

account attributes
------------------

    **kerberos-spn-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/aam/authentication/account/kerberos-spn/{name} <aam_authentication_account_kerberos_spn>`

    **sampling-enable**

        **Type:** List

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _9_sampling-enable:

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

	 **Block object keys**             

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

    **counters1**

        **Description** 'all': all; 'request-normal': Total Normal Request; 'request-dropped': Total Dropped Request; 'response-success': Total Success Response; 'response-failure': Total Failure Response; 'response-error': Total Error Response; 'response-timeout': Total Timeout Response; 'response-other': Total Other Response; 

        **Type:** string

        **Supported Values:** all, request-normal, request-dropped, response-success, response-failure, response-error, response-timeout, response-other

.. _9_kerberos-spn-list:

kerberos-spn-list
^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **account**

        **Description** Specify domain account for SPN

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **encrypted**

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

    **name**

        **Description** Specify AD account name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **password**

        **Description** Specify password of domain account

        **Type:** boolean

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

        **Default:** 0

    **realm**

        **Description** Specify Kerberos realm

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **secret-string**

        **Description** Password of AD account

        **Type:** string

        **Format:** password

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **service-principal-name**

        **Description** Specify service principal name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **user-tag**

        **Description** Customized tag

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

.. _9_stats_data:

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

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - request-normal
      - 8
      - Total Normal Request

   *  - 
      - response-success
      - 8
      - Total Success Response

   *  - 
      - response-other
      - 8
      - Total Other Response

   *  - 
      - response-failure
      - 8
      - Total Failure Response

   *  - 
      - request-dropped
      - 8
      - Total Dropped Request

   *  - 
      - response-timeout
      - 8
      - Total Timeout Response

   *  - 
      - response-error
      - 8
      - Total Error Response