FRAMES | NO FRAMES Description | Parameters | Examples | Response
Update User (Operation)
URL http://<user-url>/update
Parent Resource User


This operation is supported from 10.3.1 onwards.

Updates a user's properties.


Parameter Details
f Description: The response format. The default response format is html.

Values: html | json
user Required
Description: The username of the person who makes the update user request. The person must have "AdministratorAccess" privilege to update any user's properties or have "CanUpdateUserProfile" privilege to update his/her own properties.
properties Required
Description: A JSON object containing the user property values to update. At least one parameter from the list in below needs to be specified to update.

  • fullName: The full name of the user.
  • firstName: The first name of the user.
  • lastName: The last name of the user.
  • email: The email of the user.
  • address: The address of the user.
  • zipCode: The zip code of the user.
  • roomNumber: The room number of the user.
  • phoneNumber: The phone number of the user.
  • faxNumber: The fax number of the user.



Example Usage

Example 1: URL for updating user "cjones" email in the "Workflow" service on sampleserver. The person who makes the request is "admin0000".


Example 2: URL for updating user "cjones" all properties in the "Workflow" service on sampleserver. The person who makes the request is "admin0000".


Example 3: URL for "cjones" to update her own email and zipcode in the "Workflow" service on sampleserver. The user "cjones" has "CanUpdateUserProfile" privilege.


JSON Response Syntax

{ "success": true }

JSON Response Example

{ "success": true }