installProfileGroup_getAll.rst

installProfileGroup_getAll

.. function:: GET /users/{uid}/appliances/{aid}/installProfile/{ipid}/groups

Summary

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

Retrieves all the OS groups 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`

HTTP Request Body Parameters

None

Example Request

curl "https://uforge.example.com/api/users/{uid}/appliances/{aid}/installProfile/{ipid}/groups" -X GET \
-u USER_LOGIN:PASSWORD -H "Accept: application/xml"

.. seealso::

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