Jump to: navigation, search

Change Password

Operation Attributes Description Valid URIs
ChangePassword

oldPassword—the user's old password, encoded using base64.

newPassword—the user's new password, encoded using base64.

Verifies that the value of "oldPassword" matches the logged in user's existing password and updates it to the value of "newPassword." Configuration Server will be responsible for applying the password rules.

/me

/users/{id} (Supervisors and Admins only)

Request parameters

The following request parameters are available for the "ChangePassword" operation.

Parameter

Type

Description

Access Level

firstLogin

String

Allow the user to change his or her own password, when trying to login for the first time after the user was created the user's password was changed by an administrator. Valid values: true|false Default value: false

POST

Examples

The following changes the password of a user.

Request:

POST api/v2/me
{
    "operationName":"ChangePassword",
    "oldPassword":"MQ==",
    "newPassword":"Mg=="
}

Response:

{
   "statusCode": 0
}

The following changes the password when a user logs in for the first time.

Request:

POST api/v2/me?firstLogin=true
{
    "operationName":"ChangePassword",
    "oldPassword":"MQ==",
    "newPassword":"Mg=="
}

Response:

{
   "statusCode": 0,
}
This page was last edited on October 31, 2023, at 13:26.
Comments or questions about this documentation? Contact us for support!