.. _aam_authentication_oauth_client:

aam authentication oauth client
===============================

Authentication 2.0 Oauth client


client Specification
--------------------

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

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

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

	 **Collection Name**                   :ref:`34_client_list`

	 **Collection URI**                    /axapi/v3/aam/authentication/oauth/client

	                                       

	 **Element Name**                      client

	 **Element URI**                       /axapi/v3/aam/authentication/oauth/client/{name}

	 **Element Attributes**                client_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`34_client_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_oauth_client_POST.txt
   :literal:




.. raw:: html

   </div></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/oauth/client



.. raw:: html

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


:ref:`34_client_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/oauth/client/{name}



.. raw:: html

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


:ref:`34_client_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_oauth_client_GET.txt
   :literal:




.. raw:: html

   </div></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/oauth/client



.. raw:: html

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


:ref:`34_client_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/oauth/client/{name}



.. raw:: html

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


:ref:`34_client_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/oauth/client/{name}



.. raw:: html

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


:ref:`34_client_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

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


.. include:: ../artifacts/aam_authentication_oauth_client_PUT.txt
   :literal:




.. raw:: html

   </div></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/oauth/client



.. raw:: html

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


:ref:`34_client_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/oauth/client/{name}



.. raw:: html

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


:ref:`34_client_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_oauth_client_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _34_client_list:

client-list
-----------


    client-list is **JSON List** of :ref:`34_client_attributes` 

        client-list : [

             { :ref:`34_client_attributes` },

             { :ref:`34_client_attributes` },

             ...

         ]

.. _34_client_attributes:

client attributes
-----------------

    **client-id**

        **Description** Specify oauth client-id

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **client-secret**

        **Description** 

        **Type:** string

        **Format:** password

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **encrypted**

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

    **grant-type**

        **Description** 'implicit': The authorization server will return access token directly.; 'authorization-code': The authorization server will respond with code which can be exchange for access token.; 'hybrid-code-id-token': The authorization server will respond with both code and id token.; 'hybrid-code-token': The authorization server will respond with both code and access token.; 'hybrid-all': The authorization server will respond with code, access token and id token; 

        **Type:** string

        **Supported Values:** implicit, authorization-code, hybrid-code-id-token, hybrid-code-token, hybrid-all

    **infinity**

        **Description** Auth session never time out whatever value oauth servers' response

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** infinity and token-lifetime are mutually exclusive

    **name**

        **Description** Specify client object name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **no-reply**

        **Description** AX will not check the nonce value in response

        **Type:** boolean

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

        **Default:** 0

    **parameter-nonce-enable**

        **Description** Enable nonce parameter for authorization and token request

        **Type:** boolean

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

        **Default:** 0

    **redirection-endpoint**

        **Description** Oauth client redirection endpoint service URL.

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **scope**

        **Description** Specify request scope parameters (e.g. profile email address phone)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

    **session-init-ttl**

        **Description** TTL for Thunder to wait for first response from authorization server

        **Type:** number

        **Range:** 1-60

    **token-lifetime**

        **Description** 

        **Type:** number

        **Range:** 1-2592000

        **Mutual Exclusion:** token-lifetime and infinity are mutually exclusive

    **type**

        **Description** 'openid-connect': openid-connect; 

        **Type:** string

        **Supported Values:** openid-connect

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