.. _admin:

admin
=====

System admin user configuration


admin Specification
-------------------

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

	 **Object Key(s)**                     *user*

	 **Collection Name**                   :ref:`154_admin_list`

	 **Collection URI**                    /axapi/v3/admin

	                                       

	 **Element Name**                      admin

	 **Element URI**                       /axapi/v3/admin/{user}

	 **Element Attributes**                admin_attributes

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



.. raw:: html

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


:ref:`154_admin_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/admin



.. raw:: html

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


:ref:`154_admin_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/admin/{user}



.. raw:: html

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


:ref:`154_admin_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/admin



.. raw:: html

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


:ref:`154_admin_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/admin/{user}



.. raw:: html

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


:ref:`154_admin_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/admin/{user}



.. raw:: html

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


:ref:`154_admin_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/admin



.. raw:: html

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


:ref:`154_admin_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/admin/{user}



.. raw:: html

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


:ref:`154_admin_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _154_admin_list:

admin-list
----------


    admin-list is **JSON List** of :ref:`154_admin_attributes` 

        admin-list : [

             { :ref:`154_admin_attributes` },

             { :ref:`154_admin_attributes` },

             ...

         ]

.. _154_admin_attributes:

admin attributes
----------------

    **access**

        **Description:** access is a **JSON Block**.  Please see below for :ref:`154_access` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/admin/{user}/access <admin>`

    **access-list**

        **Description** Specify an ACL to classify a trusted host

        **Type:** boolean

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

        **Default:** 0

        **Mutual Exclusion:** access-list and trusted-host-cidr are mutually exclusive

    **action**

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

        **Type:** string

        **Supported Values:** enable, disable

        **Default:** enable

    **aws-accesskey**

        **Description:** aws-accesskey is a **JSON Block**.  Please see below for :ref:`154_aws-accesskey` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/admin/{user}/aws-accesskey <admin>`

    **azure-cred**

        **Description:** azure-cred is a **JSON Block**.  Please see below for :ref:`154_azure-cred` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/admin/{user}/azure-cred <admin>`

    **encrypted**

        **Description** Specify an ENCRYPTED password string (System admin user password)

    **passwd-string**

        **Description** Config admin user password

        **Type:** string

        **Format:** password

    **password**

        **Description:** password is a **JSON Block**.  Please see below for :ref:`154_password` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/admin/{user}/password <admin>`

    **password-key**

        **Description** Config admin user password

        **Type:** boolean

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

    **privilege-global**

        **Description** 'read': Set read privilege; 'write': Set write privilege; 'hm': Set external health monitor script content operations privilege; 

        **Type:** string

        **Supported Values:** read, write, hm

    **privilege-list**

        **Type:** List

    **privilege-shell**

        **Description** Set shell privilege

        **Type:** boolean

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

        **Default:** 0

    **privilege-shell-root**

        **Description** Set shell root privilege

        **Type:** boolean

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

        **Default:** 0

    **ssh-pubkey**

        **Description:** ssh-pubkey is a **JSON Block**.  Please see below for :ref:`154_ssh-pubkey` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/admin/{user}/ssh-pubkey <admin>`

    **trusted-host**

        **Description** Set trusted network administrator can login in

        **Type:** boolean

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

        **Default:** 0

    **trusted-host-acl-id**

        **Description** ACL ID

        **Type:** number

        **Range:** 1-99

    **trusted-host-cidr**

        **Description** Trusted IP Address with network mask

        **Type:** string

        **Format:** ipv4-cidr

        **Mutual Exclusion:** trusted-host-cidr and access-list are mutually exclusive

    **user**

        **Description** System admin user name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 31 characters

        **Maximum Length:** 1 characters

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

.. _154_azure-cred:

azure-cred
^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **delete**

        **Description** Delete an authorized Azure credentials

        **Type:** boolean

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

        **Default:** 0

    **file-url**

        **Description** File URL

        **Type:** string

        **Format:** url

    **import**

        **Description** Import an azure-credentials

        **Type:** boolean

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

        **Default:** 0

    **show**

        **Description** Show authorized azure credentials

        **Type:** boolean

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

        **Default:** 0

    **use-mgmt-port**

        **Description** Use management port as source port

        **Type:** boolean

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

        **Default:** 0

.. _154_privilege-list:

privilege-list
^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **partition-name**

        **Description** Partition Name

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **privilege-partition**

        **Description** 'partition-enable-disable': Set per-partition enable/disable privilege; 'partition-read': Set per-partition read privilege; 'partition-write': Set per-partition write privilege; 

        **Type:** string

        **Supported Values:** partition-enable-disable, partition-read, partition-write

.. _154_aws-accesskey:

aws-accesskey
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **delete**

        **Description** Delete an authorized aws accesskey

        **Type:** boolean

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

        **Default:** 0

    **file-url**

        **Description** File URL

        **Type:** string

        **Format:** url

    **import**

        **Description** Import an aws-accesskey

        **Type:** boolean

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

        **Default:** 0

    **show**

        **Description** Show authorized aws accesskey

        **Type:** boolean

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

        **Default:** 0

    **use-mgmt-port**

        **Description** Use management port as source port

        **Type:** boolean

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

        **Default:** 0

.. _154_access:

access
^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **access-type**

        **Description** 

        **Type:** string

        **Format:** enum-list

        **Default:** axapi,cli,web

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _154_ssh-pubkey:

ssh-pubkey
^^^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **delete**

        **Description** Delete an authorized public key (SSH key index)

        **Type:** number

        **Range:** 1-1000000

    **file-url**

        **Description** File URL

        **Type:** string

        **Format:** url

    **import**

        **Description** Import an authorized public key

        **Type:** boolean

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

        **Default:** 0

    **list**

        **Description** List all authorized public keys

        **Type:** boolean

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

        **Default:** 0

    **use-mgmt-port**

        **Description** Use management port as source port

        **Type:** boolean

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

        **Default:** 0

.. _154_password:

password
^^^^^^^^
	=============================== ===================================================
	**Specification**
	=============================== ===================================================
	 **Type**                        *object*

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

    **encrypted-in-module**

        **Description** Specify an ENCRYPTED password string (System admin user password)

    **password-in-module**

        **Description** Config admin user password

        **Type:** string

        **Format:** password

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters