.. _ddos_token_authentication:

ddos token-authentication
=========================

DDOS Token Authentication Configuration


token-authentication Specification
----------------------------------

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

	===================================== ==================================================================
	 **Type**                              *Intermediate Resource*

	 **Element Name**                      token-authentication

	 **Element URI**                       /axapi/v3/ddos/token-authentication

	 **Element Attributes**                token-authentication_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`token-authentication schema <ddos-token-authentication/ddos-token-authentication.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'>


Get Object



.. raw:: html

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


GET



.. raw:: html

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


/axapi/v3/ddos/token-authentication



.. raw:: html

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


token-authentication_attributes



.. raw:: html

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




.. raw:: html

   </table>

.. _1221_token-authentication_attributes:

token-authentication attributes
-------------------------------

    **authenticated-list**

        **Description:** authenticated-list is a **JSON Block**.  Please see below for :ref:`1221_authenticated-list` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/token-authentication/authenticated-list <ddos_token_authentication_authenticated_list>`

    **player-mode**

        **Description:** player-mode is a **JSON Block**.  Please see below for :ref:`1221_player-mode` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/token-authentication/player-mode <ddos_token_authentication_player_mode>`

    **players-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/ddos/token-authentication/players/{src-ip}+{src-port}+{dst-ip}+{dst-port} <ddos_token_authentication_players>`

    **secret-salt**

        **Description:** secret-salt is a **JSON Block**.  Please see below for :ref:`1221_secret-salt` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/token-authentication/secret-salt <ddos_token_authentication_secret_salt>`

    **summary**

        **Description:** summary is a **JSON Block**.  Please see below for :ref:`1221_summary` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ddos/token-authentication/summary <ddos_token_authentication_summary>`

.. _1221_authenticated-list:

authenticated-list
^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1221_player-mode:

player-mode
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **mode**

        **Description** 'one-to-one': Only one player talks to one server; 'many-to-one': Many player talk to one server; 

        **Type:** string

        **Supported Values:** one-to-one, many-to-one

        **Default:** many-to-one

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1221_summary:

summary
^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1221_secret-salt:

secret-salt
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

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

    **current-salt**

        **Description** Current salt value

        **Type:** number

        **Range:** 0-4294967295

    **previous-salt**

        **Description** Previous salt value

        **Type:** number

        **Range:** 0-4294967295

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _1221_players-list:

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

	 **Block object keys**             

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

    **dst-ip**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **dst-port**

        **Description** 

        **Type:** number

        **Range:** 0-65535

    **magic-value**

        **Description** 

        **Type:** number

        **Range:** 0-4294967295

    **src-ip**

        **Description** 

        **Type:** string

        **Format:** ipv4-address

    **src-port**

        **Description** 

        **Type:** number

        **Range:** 0-65535