Skip to main content

PUT /userAccounts/{id}

Use this method to modify the properties for a specific user account.

Tip
To change the password for a specific user account, use PUT /userAccounts/passwordChange

Authentication​

Authentication with username and password is required.

Request URL​

PUT https://{management_server_IP}/userAccounts/{id}

where {id} is the unique ID of the user to be modified. To obtain the user ID, use the GET /userAccounts method.

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDescription
descriptionOptionalStringDescription for the user account.
groupsOptionalArray of stringsList of role groups to which this user account belongs

To obtain the role groups, use GET /roles.

userNameOptionalStringUser-account name.

This value must match an existing user name. To obtain the user names, use GET /userAccounts.

The following example modifies a user account.
{
    "description": "new description",
    "groups": ["lxc-supervisor","lxc-admin"],
    "userName": "JOE"
}

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
409ConflictThere is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
  • An account with the specified user name exists already.
  • A violation of the security policy occurred.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
resultStringResults of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messagesArray of objectsInformation about one or more messages
 idStringMessage identifier of a returned message
 textStringMessage text associated with the message identifier
 explanationStringAdditional information to clarify the reason for the message
 recoveryArray of objectsRecovery information
  textStringUser actions that can be taken to recover from the event
  URLStringLink to the help system for more information, if available
The following example is returned if the request is successful.
{
   "result": "success",
   "messages": [{
      "explanation": "The request to modify the user ID JOE was successful.",
      "id": "FQXHMSE0260I",
      "recovery": {
         "text": "Information only; no action is required.",
         "URL": ""
      },
      "text": "The request to modify the user ID JOE completed successfully."
   }]
}