.. _aam_authorization_policy_jwt_claim_map:

aam authorization policy jwt-claim-map
======================================

Map attributes to JWT claims


jwt-claim-map Specification
---------------------------

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

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

	 **Object Key(s)**                     *attr-num*

	 **Collection Name**                   :ref:`117_jwt-claim-map_list`

	 **Collection URI**                    /axapi/v3/aam/authorization/policy/{name}/jwt-claim-map

	                                       

	 **Element Name**                      jwt-claim-map

	 **Element URI**                       /axapi/v3/aam/authorization/policy/{name}/jwt-claim-map/{attr-num}

	 **Element Attributes**                jwt-claim-map_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`jwt-claim-map schema <aam-authorization-policy-jwt-claim-map/aam-authorization-policy-jwt-claim-map.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/authorization/policy/{name}/jwt-claim-map



.. raw:: html

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


:ref:`117_jwt-claim-map_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/authorization/policy/{name}/jwt-claim-map



.. raw:: html

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


:ref:`117_jwt-claim-map_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/authorization/policy/{name}/jwt-claim-map/{attr-num}



.. raw:: html

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


:ref:`117_jwt-claim-map_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/authorization/policy/{name}/jwt-claim-map



.. raw:: html

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


:ref:`117_jwt-claim-map_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/authorization/policy/{name}/jwt-claim-map/{attr-num}



.. raw:: html

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


:ref:`117_jwt-claim-map_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/authorization/policy/{name}/jwt-claim-map/{attr-num}



.. raw:: html

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


:ref:`117_jwt-claim-map_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/authorization/policy/{name}/jwt-claim-map



.. raw:: html

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


:ref:`117_jwt-claim-map_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/authorization/policy/{name}/jwt-claim-map/{attr-num}



.. raw:: html

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


:ref:`117_jwt-claim-map_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _117_jwt-claim-map_list:

jwt-claim-map-list
------------------


    jwt-claim-map-list is **JSON List** of :ref:`117_jwt-claim-map_attributes` 

        jwt-claim-map-list : [

             { :ref:`117_jwt-claim-map_attributes` },

             { :ref:`117_jwt-claim-map_attributes` },

             ...

         ]

.. _117_jwt-claim-map_attributes:

jwt-claim-map attributes
------------------------

    **attr-num**

        **Description** Spcify attribute ID for claim mapping

        **Type:** number

        **Range:** 1-32

    **bool-val**

        **Description** 'true': True; 'false': False; 

        **Type:** string

        **Supported Values:** true, false

    **boolean-type**

        **Description** Claim type is boolean

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** boolean-type, string-type, and number-type are mutually exclusive

    **claim**

        **Description** Specify JWT claim name to map to.

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **num-val**

        **Description** Specify JWT claim value.

        **Type:** number

        **Range:** 0-4294967295

    **number-type**

        **Description** Claim type is number

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** number-type, string-type, and boolean-type are mutually exclusive

    **str-val**

        **Description** Specify JWT claim value.

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **string-type**

        **Description** Claim type is string

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** string-type, number-type, and boolean-type are mutually exclusive

    **type**

        **Description** Specify claim type

        **Type:** boolean

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

        **Default:** 0

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters