Change a user password

This is an API function to change a user password. This API function corresponds to the operation on the screen that is displayed by clicking the [User] tab after selecting the [Security] on the operation screen of Manager.

= Remarks =

The following set of API functions is actually the same. (/api/v1/user/userId)

  • Modify user details
  • Change a user password

In this manual, to write each API function separately for individual purposes, the request parameters are changed according to the purposes.
= Remarks =

The response parameters of the following API functions are the same.

  • Create user
  • Modify user details
  • Acquire user details
  • Change a user password
Format
curl -X PUT --header 'Content-Type: application/json'
            --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            -d 'REQUESTBODYINJSONFORMAT'
            'http://HOSTNAME:PORTNUMBER/api/v1/user/userId'
Request body (JSON format)
{
  "currentPasswd": "string",
  "newPasswd": "string"
}
Request parameter (JSON format)
Item name Request parameter Type Value Default value
Current Password currentPasswd String

If an administrator changes the password of the other users, this parameter is not required.

Maximum 64 characters

ASCII printable characters only

 Impossible to omit
New Password newPasswd String

Maximum 64 characters

ASCII printable characters only

 Impossible to omit
Request parameter (Path format)
Item name Request parameter Type Value Default value
User ID userId String   Impossible to omit
Response
{
  "passwdCreated": true,
  "userId": "string",
  "userName": "string",
  "userRoleId": "string"
  "userRoleName": "string"
}
Response parameter

For details of the response parameters, see Response parameter described in Acquire user details.