Change Password of User

PUT /api/v1/mngt/change_password/

Change the password of a user ( of any type) that the authenticated user can manage. This API is classically used by an Admin to modify (reset) the password of a user he manages.

Example request:

PUT /api/v1/mngt/change_password/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "username": "foo",
   "newPassword": "bar7!63",
}
Request JSON Object:
  • username (string) – the username of the user who needs his password to be changed

  • newPassword (string) – the new password of the user

Example response:

HTTP/1.1 200 OK
Status Codes:
  • 200 OK – no error

  • 404 Not Found – user not found or not allowed to be managed by the authenticated user (to avoid user enumeration)

Configuration Information for Change Password of User

The APIO behaviour for the validation of the passwords is controlled by the following setting:

"VALIDATE_PASSWORD_LOCALLY": true
"VALIDATE_PASSWORD_LOCAL_RULE": true
Settings description:
  • VALIDATE_PASSWORD_LOCALLY: APIO will check the passwords based on the user level rules from the network element. Default is false.

  • VALIDATE_PASSWORD_LOCAL_RULE: if the previous settings is false and that this settings is tru, the APIO will check the password with respect to an hardcoded local rule (min 8 chars, aat least 1 upper and 1 lower cases). This local rule can be overwritten in project mode. Default is false.