.. _aam_authorization_policy_attribute:

aam authorization policy attribute
==================================

Authorization-policy attribute configuration


attribute Specification
-----------------------

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

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

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

	 **Collection Name**                   :ref:`116_attribute_list`

	 **Collection URI**                    /axapi/v3/aam/authorization/policy/{name}/attribute

	                                       

	 **Element Name**                      attribute

	 **Element URI**                       /axapi/v3/aam/authorization/policy/{name}/attribute/{attr-num}

	 **Element Attributes**                attribute_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`attribute schema <aam-authorization-policy-attribute/aam-authorization-policy-attribute.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}/attribute



.. raw:: html

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


:ref:`116_attribute_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}/attribute



.. raw:: html

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


:ref:`116_attribute_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}/attribute/{attr-num}



.. raw:: html

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


:ref:`116_attribute_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}/attribute



.. raw:: html

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


:ref:`116_attribute_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}/attribute/{attr-num}



.. raw:: html

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


:ref:`116_attribute_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}/attribute/{attr-num}



.. raw:: html

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


:ref:`116_attribute_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}/attribute



.. raw:: html

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


:ref:`116_attribute_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}/attribute/{attr-num}



.. raw:: html

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


:ref:`116_attribute_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _116_attribute_list:

attribute-list
--------------


    attribute-list is **JSON List** of :ref:`116_attribute_attributes` 

        attribute-list : [

             { :ref:`116_attribute_attributes` },

             { :ref:`116_attribute_attributes` },

             ...

         ]

.. _116_attribute_attributes:

attribute attributes
--------------------

    **A10-AX-AUTH-URI**

        **Description** Custom-defined attribute

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** A10-AX-AUTH-URI and attribute-name are mutually exclusive

    **a10-dynamic-defined**

        **Description** The value of this attribute will depend on AX configuration instead of user configuration

        **Type:** boolean

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

        **Default:** 0

    **any**

        **Description** Matched when attribute is present (with any value).

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** any and attr-type are mutually exclusive

    **attr-int**

        **Description** 'equal': Operation type is equal; 'not-equal': Operation type is not equal; 'less-than': Operation type is less-than; 'more-than': Operation type is more-than; 'less-than-equal-to': Operation type is less-than-equal-to; 'more-than-equal-to': Operation type is more-thatn-equal-to; 

        **Type:** string

        **Supported Values:** equal, not-equal, less-than, more-than, less-than-equal-to, more-than-equal-to

    **attr-int-val**

        **Description** Set attribute value

        **Type:** number

        **Range:** 0-4294967295

    **attr-ip**

        **Description** 'equal': Operation type is equal; 'not-equal': Operation type is not-equal; 

        **Type:** string

        **Supported Values:** equal, not-equal

    **attr-ipv4**

        **Description** IPv4 address

        **Type:** string

        **Format:** ipv4-address

    **attr-num**

        **Description** Set attribute ID for authorization policy

        **Type:** number

        **Range:** 1-32

    **attr-number**

        **Description** 'equal': Operation type is equal; 'not-equal': Operation type is not equal; 'less-than': Operation type is less-than; 'more-than': Operation type is more-than; 'less-than-equal-to': Operation type is less-than-equal-to; 'more-than-equal-to': Operation type is more-thatn-equal-to; 

        **Type:** string

        **Supported Values:** equal, not-equal, less-than, more-than, less-than-equal-to, more-than-equal-to

    **attr-number-val**

        **Description** Set attribute value

        **Type:** string

        **Maximum Length:** 20 characters

        **Maximum Length:** 1 characters

    **attr-str**

        **Description** 'match': Operation type is match; 'sub-string': Operation type is sub-string; 

        **Type:** string

        **Supported Values:** match, sub-string

    **attr-str-val**

        **Description** Set attribute value

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **attr-type**

        **Description** Specify attribute type

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** attr-type and any are mutually exclusive

    **attribute-name**

        **Description** Specify attribute name

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

        **Mutual Exclusion:** attribute-name and A10-AX-AUTH-URI are mutually exclusive

    **custom-attr-str**

        **Description** 'match': Operation type is match; 'sub-string': Operation type is sub-string; 

        **Type:** string

        **Supported Values:** match, sub-string

    **custom-attr-type**

        **Description** Specify attribute type

        **Type:** boolean

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

        **Default:** 0

    **integer-type**

        **Description** Attribute type is integer

        **Type:** boolean

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

        **Default:** 0

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

    **ip-type**

        **Description** IP address is transformed into network byte order

        **Type:** boolean

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

        **Default:** 0

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

    **number-type**

        **Description** Attribute type is decimal number

        **Type:** boolean

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

        **Default:** 0

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

    **string-type**

        **Description** Attribute type is string

        **Type:** boolean

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

        **Default:** 0

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

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters