/api/space/user-management/users/{user-id}/change-password

The following operations are supported on this resource:

  • PUT - Change user's password
  • POST - Reset password to temporary password
  • POST - Change user's password
PUT /users/{user-id}/change-password
(Deprecated)
Version 1

This API is used to change a user's password.

Sample Usage

PUT /users/{user-id}/change-password


  • Parameters:
    Name Type URI Type Description Required
    id Integer Path The ID of the user whose password will be changed. Y
  • Sample Input XML:
    <password>
      <oldPassword>test@123</oldPassword>
      <newPassword>test@321</newPassword>
    </password>

  • Sample Output XML:
    <password>
      <oldPassword>test@123</oldPassword>
      <newPassword>test@321</newPassword>
    </password>


  • Sample Input JSON:
    {
     "password":{
      "oldPassword":"test@123",
      "newPassword":"test@321"
     }
    }

  • Sample Output JSON:
    {
     "password":{
      "oldPassword":"test@123",
      "newPassword":"test@321"
     }
    }

  • Access Control

    The following capabilities are required to access this API: ModifyUser

    POST /users/{user-id}/change-password Version 3

    Reset password to temporary password.

    Sample Usage

    POST /users/{user-id}/change-password


    • Parameters:
      Name Type URI Type Description Required
      user-id Integer Path ID of the user Y
  • Sample Input XML:
    <change-password>
         <old-password>String</old-password>
         <password-expiry-time>java.sql.Date</password-expiry-time>
         <email-password>Boolean</email-password>
    </change-password>

  • Sample Input JSON:
    {
       "change-password" : {
         "old-password" : "String" ,
         "password-expiry-time" : "java.sql.Date" ,
         "email-password" : "Boolean"
       }
    }

  • Access Control

    The following capabilities are required to access this API: ModifyUser

    POST /users/{user-id}/change-password Version 1

    Change user's password.

    Sample Usage

    POST /users/{user-id}/change-password


    • Parameters:
      Name Type URI Type Description Required
      id Integer Path The user ID of the user whose password will be changed. Y
  • Sample Input XML:
    <change-password>
      <oldPassword>test12</oldPassword>
      <newPassword>mytest32</newPassword>
    </change-password>

  • Sample Output XML:
    <change-password>
      <oldPassword>test12</oldPassword>
      <newPassword>mytest32</newPassword>
    </change-password>

  • Sample Input JSON:
    {
      "change-password": {
        "oldPassword":"test@123",
        "newPassword":"test@321"
      }
    }

  • Sample Output JSON:
    {
      "change-password":{
        "oldPassword":"test@123",
        "newPassword":"test@321"
      }
    }