.. _system_shell_privileges:

system shell-privileges
=======================

Configuration for special shell privileges


shell-privileges Specification
------------------------------

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

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

	 **Element Name**                      shell-privileges

	 **Element URI**                       /axapi/v3/system/shell-privileges

	 **Element Attributes**                shell-privileges_attributes

	 **Partition Visibility**              shared

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



.. raw:: html

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


:ref:`3386_shell-privileges_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/system/shell-privileges



.. raw:: html

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


:ref:`3386_shell-privileges_attributes`



.. 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/system/shell-privileges



.. raw:: html

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


:ref:`3386_shell-privileges_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/system/shell-privileges



.. raw:: html

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


:ref:`3386_shell-privileges_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/system/shell-privileges



.. raw:: html

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


:ref:`3386_shell-privileges_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _3386_shell-privileges_attributes:

shell-privileges attributes
---------------------------

    **enable-shell-privileges**

        **Description** enable the shell privileges for a given customer

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