subscriptionProfileAdmins_update.rst

subscriptionProfileAdmins_update

.. function:: PUT /orgs/{oid}/subscriptions/{spid}/admins

Summary

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

Updates the administrators list for a subscription profile.

Any user listed in the subscription profile that is not specified in the new user list will be removed from the subscription profile.

Security Summary

• Requires Authentication: true
• Entitlements Required: org_administrate

URI Parameters

• oid (required): the id of the :ref:`org-object`
• spid (required): the id of the :ref:`subscriptionprofile-object`

HTTP Request Body Parameters

A :ref:`userProfiles-object` object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/subscriptions/{spid}/admins" -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:users xmlns:ns0="http://www.usharesoft.com/uforge">
        <users>
                <user>
                        <loginName>guest</loginName>
                </user>
        </users>
</ns0:users>

.. seealso::

         * :ref:`subscriptionProfileOS-update`
         * :ref:`subscriptionProfileQuotas-update`
         * :ref:`subscriptionProfileRoles-update`
         * :ref:`subscriptionProfileTargetFormat-update`
         * :ref:`subscriptionProfileTargetPlatform-update`
         * :ref:`subscriptionProfile-create`
         * :ref:`subscriptionProfile-get`
         * :ref:`subscriptionProfile-getAll`
         * :ref:`subscriptionProfile-remove`
         * :ref:`subscriptionProfile-update`
         * :ref:`subscriptionprofile-object`