PUT /userAccounts/<id>

Use PUT 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 user name 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

Attributes Required / Optional Type Description
description Optional String Description for the user account.
groups Optional Array of strings List of role groups to which this user account belongs

To obtain the role groups, use GET /roles.

userName Optional String User-account name.

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

Request example

{
    "description": "new description",
    "groups": ["lxc-supervisor","lxc-admin"],
    "userName": "JOE"
}

Response codes

Code Description
201 Created. The user account was modified successfully.
400 Bad request. An argument is missing or not valid. a descriptive error message will be returned in the body.
404 Not found. The user was not found. A descriptive error message will be returned in the body.
409 Conflict. One or more of the following conflicts has occurred:
  • An account with the specified user name exists already.
  • A violation of the security policy occurred.
500 Internal server error. A descriptive error message will be returned in the body.

Response body

Attributes Type Description
result String Results 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.
messages Array of objects Information about one or more messages
  id String Message identifier of a returned message
  text String Message text associated with the message identifier
  explanation String Additional information to clarify the reason for the message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available

Response example

{
    "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."
    }]
}