Jump to: navigation, search

Change Password and Login

Method

PUT

Syntax

 
/grs/v1/changepassword

Request Body

 
{   
   "newPassword":"AnotherPW"
 }

Response Body

 | 
{
"apiToken": "749cf21d112cc88cdeb72c441724ec0b
71e53a6a7666e847209cac9593f96f5e",
"lastLogin": 0
}

HTTP Status Codes

  • 200 OK—Response Body Provided
  • 401Unauthorized—Userid / Original Password not valid
  • 503—Service Unavailable

Notes

A user cannot simply change their password at any time. The password must expire or the flag to "reset" password must be enabled in Configuration Server. When a user attempts to log in and gets the "Password Change Required" error, they can then use this API to change their password and log in. UserID and Original Password are provided in the basic authorization header. The new password is passed in the request body. If the password change is successful, the API token and last login time (if available) will be returned (just like normal login).

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 16, 2017, at 00:20.