User API - Bulk - Reset password

NOTE : This API endpoint will be supported in version 5.0 onwards

Overview

This API call is used to reset a user password.

HTTP Request

PUT   /api/4/users?action=resetpassword

HTTP Request Object

Request xml

<users> 
    <user> 
        <userid>102</userid>
        <userid>101</userid>
    </user>
</users>

Request JSON

{
    "user": {
        "userid": [
            "102",
            "101"
        ]
    }
}

HTTP Headers

HTTP Response

Success

HTTP response 200

Example

PUT  http://example.com/context/api/4/users?action= resetpassword

XML Format

<users>
    <user>
        <id>101</id>
        <resetlink>http://example.com/context/ConformUser_input.action?conformUser.passwordResetKey=Odjc3OQUHkH6wMoDW0JNh2n_DQwvwbLzdIKnCl1XxdisWR8MYEA_4NSg71WufYKlbQN3DHCqT9I=</resetlink>
    </user>
    <user>
        <id>102</id>
        <resetlink>http://example.com/context/ConformUser_input.action?conformUser.passwordResetKey=Q4k0eFeyUOuu3lsRnO0d9c2N4rJa9mNXe_HWXDgW6Aa1q3Un5lV8SOKnpHBnCbtF8TPOvFRAjPc=</resetlink>
    </user>
</users>

JSON Format

{
    "user": [
        {
            "id": "102",
            "resetlink": "http://example.com/context/ConformUser_input.action?conformUser.passwordResetKey=Q4k0eFeyUOuu3lsRnO0d9c2N4rJa9mNXe_HWXDgW6Aa1q3Un5lV8SAkbIuqv-XGGBtLkkapUNq8="
        },
        {
            "id": "101",
            "resetlink": "http://example.com/context/ConformUser_input.action?conformUser.passwordResetKey=Odjc3OQUHkH6wMoDW0JNh2n_DQwvwbLzdIKnCl1XxdisWR8MYEA_4KQ4v1dlYpV0mxIcll-obd0="
        }
    ]
}

Error messages