Start of change

usermgmt/changepassword: PUT

Changes the password for the user.

Availability

Available on all IBM Storage Scale editions.

Description

The PUT usermgmt/changepassword request changing the password of the user.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v2/usermgmt/changepassword
where
usermgmt
The user whose password is going to be changed. Required.
changepassword
Specifies the action to be performed on the user data. Required.

Request headers

Content-Type: application/json
Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:
Table 1. List of parameters
Parameter name Description and applicable keywords Required/optional
username The name of the user whose password needs to be changed. Required.
newpassword The new password that needs to replace the existing password. Required.

Request data

{
          "username": "String",
         "newpassword": "String"
}

For more information about the fields in the following data structures, see the links at the end of this topic.

"username":"String"
The user whose password needs to be changed.
"newpassword": "String"
The new password that needs to replace the existing password.

Response data

{
   "status": {
      "code":ReturnCode",
      "message":"ReturnMessage"
   },
   "jobs": [
      {
         "result":"", 
           { 
             "commands":"String",
             "progress":"String,
             "exitCode":"Exit code",
             "stderr":"Error",
             "stdout":"String",
           },
         "request":" ",
           {
             "type":"{GET | POST | PUT | DELETE}",
             "url":"URL",
             "data":""",
           }
         "jobId":"ID",
         "submitted":"Time",
         "completed":Time",
         "status":"Job status",
         }
   ],
  }
For more information about the fields in the following data structures, see the links at the end of this topic.
"jobs":
An array of elements that describe jobs. Each element describes one job.
"status":
Return status.
"message": "ReturnMessage",
The return message.
"code": ReturnCode
The return code.
"result"
"commands":"String'
Array of commands that are run in this job.
"progress":"String'
Progress information for the request.
"exitCode":"Exit code"
Exit code of command. Zero is success, nonzero denotes failure.
"stderr":"Error"
CLI messages from stderr.
"stdout":"String"
CLI messages from stdout.
"request"
"type":"{GET | POST | PUT | DELETE}"
HTTP request type.
"url":"URL"
The URL through which the job is submitted.
"data":" "
Optional.
"jobId":"ID",
The unique ID of the job.
"submitted":"Time"
The time at which the job was submitted.
"completed":"Time"
The time at which the job was completed.
"status":"RUNNING | COMPLETED | FAILED"
Status of the job.

Examples

The following example how to change the password.

Corresponding request URL: 
curl -k -u admin:admin001 -X PUT --header 'content-type:application/json' --header 'accept:application/json' 
https://<IP or host name of API server>:port/scalemgmt/v2/usermgmt/changepassword
   "username": "String:, 
   "newpassword": "String"
Response data:
Note: In the JSON data that is returned, the return code indicates whether the command is successful. The response code 200 indicates that the command successfully retrieved the information. Error code 400 represents an invalid request and 500 represents internal server error. 
 { 
"jobs": [ { 
      "jobId": 1000000000013, 
      "status": "RUNNING", 
      "submitted": "2023-05-09 04:06:40,886", 
      "completed": "N/A", 
      "runtime": 15, 
"request": { 
      "type": "PUT", 
      "url": "/scalemgmt/v2/usermgmt/changepassword" }, 
      "result": {}, 
      "pids": [] } ], 
 "status": { 
      "code": 202, 
      "message": "The request was accepted for processing." } }
End of change