Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 1.25 KB

role_update.rst

File metadata and controls

61 lines (39 loc) · 1.25 KB
Raw

role_update

PUT /orgs/{oid}/roles

Summary

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

Updates the information of a role.

Please refer to role-object for a complete list of all the role attributes.

Security Summary

  • Requires Authentication: true
  • Entitlements Required: org_administrate

URI Parameters

  • oid (required): the id of the org-object

HTTP Request Body Parameters

A role-object object

Example Request

curl "https://uforge.example.com/api/orgs/{oid}/roles" -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:role xmlns:ns0="http://www.usharesoft.com/uforge">
    <name>Example Role Updated</name>
</ns0:role>
  • entitlement-object
  • entitlement-getAll
  • role-object
  • role-create
  • role-delete
  • role-getAll