Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 2.03 KB

userFormats_update.rst

File metadata and controls

79 lines (56 loc) · 2.03 KB
Raw

userFormats_update

PUT /users/{uid}/formats

Summary

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

Updates the list of machine image formats that an user has access to.

Please refer to imageformat-object for a complete list of all the image format attributes.

Warning

Any image format that the user currently has access to that is not specified in the new target format list will be removed, this effectively de-activates those image formats for the user.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_formats_administrate

URI Parameters

  • uid (required): the user name (login name) of the user-object

HTTP Request Body Parameters

A imageFormats-object object

Example Request

curl "https://uforge.example.com/api/users/{uid}/formats" -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:imageFormats xmlns:ns0="http://www.usharesoft.com/uforge">
    <imageFormats>
        <imageFormat>
            <access>true</access>
            <active>true</active>
            <uri>format/5</uri>
        </imageFormat>
        <imageFormat>
            <access>true</access>
            <active>true</active>
            <uri>format/7</uri>
        </imageFormat>
    </imageFormats>
</ns0:imageFormats>
  • imageformat-object
  • targetformat-api-resources
  • targetformat-object
  • targetplatform-api-resources
  • targetplatform-object
  • userFormats-getAll
  • userTargetFormat-getAll
  • userTargetFormat-update
  • userTargetPlatformFormat-getAll
  • userTargetPlatforms-getAll
  • userTargetPlatforms-update