installProfileUser_update.rst

installProfileUser_update

.. function:: PUT /users/{uid}/appliances/{aid}/installProfile/{ipid}/users/{osuid}

Summary

• Method: PUT
• Response Code: 200
• Response Formats: application/xml application/json
• Since: UForge 3.4

Updates an OS user registered in an install profile.

Security Summary

• Requires Authentication: true
• Entitlements Required: appliance_create

URI Parameters

• uid (required): the user name (login name) of the :ref:`user-object` that has created the appliance
• ipid (required): the id of the :ref:`installprofile-object`
• aid (required): the id of the :ref:`appliance-object`
• osuid (required): the id of the :ref:`osuser-object`

HTTP Request Body Parameters

A :ref:`osUser-object` object

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/users/{osuid}" -X PUT \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"-H "Content-type: application/xml" --data-binary "@representation.xml"

Example of representation.xml content (the request body):

<ns0:osUser xmlns:ns0="http://www.usharesoft.com/uforge">
        <fullName>OS User Example Updated</fullName>
        <homeDir>/home/OSUserExampleUpdated</homeDir>
</ns0:osUser>

.. seealso::

         * :ref:`appliance-object`
         * :ref:`applianceinstallprofile-api-resources`
         * :ref:`installProfileGroup-create`
         * :ref:`installProfileGroup-delete`
         * :ref:`installProfileGroup-deleteAll`
         * :ref:`installProfileGroup-get`
         * :ref:`installProfileGroup-getAll`
         * :ref:`installProfileGroup-update`
         * :ref:`installProfileUser-create`
         * :ref:`installProfileUser-delete`
         * :ref:`installProfileUser-deleteAll`
         * :ref:`installProfileUser-get`
         * :ref:`installProfileUser-getAll`
         * :ref:`installprofile-object`
         * :ref:`osgroup-object`
         * :ref:`osuser-object`