.. _rba:

rba
===

Role Based Access configuration


rba Specification
-----------------

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

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

	 **Element Name**                      rba

	 **Element URI**                       /axapi/v3/rba

	 **Element Attributes**                rba_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`2465_rba_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/rba_POST.txt
   :literal:




.. raw:: html

   </div></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/rba



.. raw:: html

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


:ref:`2465_rba_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/rba_GET.txt
   :literal:




.. raw:: html

   </div></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/rba



.. raw:: html

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


:ref:`2465_rba_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/rba



.. raw:: html

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


:ref:`2465_rba_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/rba



.. raw:: html

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


:ref:`2465_rba_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/rba_DELETE.txt
   :literal:




.. raw:: html

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


.. raw:: html

   </table>

.. _2465_rba_attributes:

rba attributes
--------------

    **action**

        **Description** 'enable': Enable RBA; 'disable': Disable RBA; 

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **group-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/rba/group/{name} <rba_group>`

    **role-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/rba/role/{name} <rba_role>`

    **user-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/rba/user/{name} <rba_user>`

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _2465_group-list:

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

	 **Block object keys**             

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

    **name**

        **Description** Name of a RBA group

        **Type:** string

        **Maximum Length:** 32 characters

        **Maximum Length:** 1 characters

    **partition-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/rba/group/{name}/partition/{partition-name} <rba_group>`

    **user-list**

        **Type:** List

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

.. _2465_group-list_partition-list:

group-list_partition-list
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **partition-name**

        **Description** partition name

        **Type:** string

        **Maximum Length:** 14 characters

        **Maximum Length:** 1 characters

    **role-list**

        **Type:** List

    **rule-list**

        **Type:** List

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

.. _2465_group-list_partition-list_role-list:

group-list_partition-list_role-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **role**

        **Description** Role in a given partition

        **Type:** string

        **Maximum Length:** 32 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/rba/role <rba_role>`

.. _2465_group-list_partition-list_rule-list:

group-list_partition-list_rule-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **object**

        **Description** Lineage of object class for permitted operation

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **operation**

        **Description** 'no-access': no-access; 'read': read; 'oper': oper; 'write': write; 

        **Type:** string

        **Supported Values:** no-access, read, oper, write

.. _2465_group-list_user-list:

group-list_user-list
^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **user**

        **Description** Users in the group

        **Type:** string

        **Maximum Length:** 32 characters

        **Maximum Length:** 1 characters

.. _2465_user-list:

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

	 **Block object keys**             

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

    **name**

        **Description** Name of a user account

        **Type:** string

        **Maximum Length:** 32 characters

        **Maximum Length:** 1 characters

    **partition-list**

        **Type:** List

        **Reference Object:** :doc:`/axapi/v3/rba/user/{name}/partition/{partition-name} <rba_user>`

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

.. _2465_user-list_partition-list:

user-list_partition-list
^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **partition-name**

        **Description** partition name

        **Type:** string

        **Maximum Length:** 14 characters

        **Maximum Length:** 1 characters

    **role-list**

        **Type:** List

    **rule-list**

        **Type:** List

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

.. _2465_user-list_partition-list_role-list:

user-list_partition-list_role-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **role**

        **Description** Role in a given partition

        **Type:** string

        **Maximum Length:** 32 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/rba/role <rba_role>`

.. _2465_user-list_partition-list_rule-list:

user-list_partition-list_rule-list
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **object**

        **Description** Lineage of object class for permitted operation

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **operation**

        **Description** 'no-access': no-access; 'read': read; 'oper': oper; 'write': write; 

        **Type:** string

        **Supported Values:** no-access, read, oper, write

.. _2465_role-list:

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

	 **Block object keys**             

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

    **default-privilege**

        **Description** 'no-access': no-access; 'read': read; 'write': write; 

        **Type:** string

        **Supported Values:** no-access, read, write

        **Default:** no-access

    **name**

        **Description** Name for the RBA role

        **Type:** string

        **Maximum Length:** 32 characters

        **Maximum Length:** 1 characters

    **partition-only**

        **Description** Partition RBA Role

        **Type:** boolean

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

        **Default:** 0

    **rule-list**

        **Type:** List

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

.. _2465_role-list_rule-list:

role-list_rule-list
^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **object**

        **Description** Lineage of object class for permitted operation

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **operation**

        **Description** 'no-access': no-access; 'read': read; 'oper': oper; 'write': write; 

        **Type:** string

        **Supported Values:** no-access, read, oper, write