Skip to main content

PUT /userAccounts/passwordChange

Use this method to change the password for the user account that is currently logged in to the Lenovo XClarity Administrator.

Authentication​

Authentication with username and password is required.

Request URL​

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

Query parameters​

None

Request body​

AttributesRequired / OptionalTypeDescription
confirmPasswordRequiredStringConfirmation of the new password
newPasswordRequiredStringNew password
passwordRequiredStringCurrent password for the user account that is currently logged in
The following example change the password for the logged in user account.
{
    "confirmPassword": "theNewPassw0rd",
    "newPassword": "theNewPassw0rd",
    "password": "currentPassw0rd"
}

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.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

AttributesTypeDescription
responseObject 
 authenticatedBooleanIndicates if the current password was authenticated successfully. This can be one of the following values.
  • true. The password was authenticated.
  • false. The password was not authenticated.
 changedBooleanIndicates if the current password was changed successfully. This can be one of the following values.
  • true. The password was changed successfully.
  • false. The password was not changed successfully.
resultStringThe request results. This can be one of the following values.
  • success. The request completed successfully.
  • failure. The request failed. A descriptive error message was returned.
messagesArray of objectsInformation about one or more messages
 textStringMessage text associated with the message identifier
 explanationStringAdditional information to clarify the reason for the message
 idStringThe message identifier of a returned 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.
{
    "response": {
        "changed": true,
        "authenticated": true
    },
    "result": "success",
    "messages": [{
        "explanation": "",
        "id": "FQXHMSE0001I",
        "recovery": {
            "text": "Information only; no action is required.",
            "URL": ""
        },
        "text": "The request completed successfully."
    }]
}