updateUser

Update a user

Specify the user name in the 'user' parameter and use the JSON string to specify new information about the user. This command can update the name and email address of the user, but not the password.

Format

udclient [global-args...] [global-flags...]
  updateUser [parameters] [JSON file]

Parameters

Table 1. Parameters
Parameter	Type	Required	Description
user	string	true	Name/ID of the user. The name will be case-sensitive if a case-sensitive realm is provided.
realm	string	false	Limit any user name search to given AuthenticationRealm.

Template

This command takes a JSON request string or file. Use the following template for the request:

{
  "actualName": "User real name (optional)",
  "email": "Email address (optional)"
}

Example

udclient -username jsmith -password passwd 
  -weburl https://deployserver.example.com:8443
  updateUser 
  -user jsmith
  updateUser.json

Example JSON request

{
  "password": "password",
  "actualName": "Jane Smith",
  "email": "jsmith@example.org"
}

Related REST command: Update a user.