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.

Request

PUT https://{hostname}:{port}
    /cli/user/update?{parameters}
Accept: {contentType}
Table 1. Request 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.
Table 2. Header parameters
Parameter Type Required Description
Accept
  • application/json
  • application/yaml
 true
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 JSON request

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

Related CLI command: updateUser.