Change password
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 15, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Change the password of a subscriber. The current password must be available to perform this action.
The API caller must have one of the following roles to run the API:
  • CustomerAdministrator
  • User
  • VSR
     
Table 1. API details
Method
Resource address
Input representation
POST
service/authentication/changePassword
A JavaScript™ Object Notation (JSON) entry that represents a subscriber.


Input attributes


The input attribute must be a well formatted JSON object with following information.

Table 2. Input attributes
Attribute
Required
Description
LoginName
Yes
The email address of the user.
OldPassword
Yes
The current password for the user.
NewPassword
Yes
The new password for the user.
ConfirmPassword
Yes
The confirmed new password of the user.


Sample payload

{

"UserCredential": {

"LoginName": "JohnDoe@example",

"OldPassword": "Pa88w0rd",

"NewPassword": "Pa77w0rd",

"ConfirmPassword": "Pa77w0rd"

}

} 


For a list of common HTTP status codes that are returned for API calls, see HTTP status codes.

Parent topic: Authentication services
Input
Method URI Description
POST /api/bss/service/authentication/changePassword Change the password of a subscriber. The current password must be available to perform this action.
The API caller must have one of the following roles to run the API:
CustomerAdministrator
User
VSR
Content Type: application/json
Sample Request:
{

    "UserCredential": {

        "LoginName": "JohnDoe@example",

        "OldPassword": "Pa88w0rd",

        "NewPassword": "Pa77w0rd",

        "ConfirmPassword": "Pa77w0rd"

    }

} 

Use the table below that represents the expected fields:
Name Type Optional Description
LoginName
string No The email address of the user.
OldPassword
string No The current password for the user.
NewPassword
string No The new password for the user.
ConfirmPassword
string No The confirmed new password of the user.
Output
Code Description
401
Unauthorized. Returned when no authenticated user or no userid, email, or key parameter are provided on the request.