Xsolla-logo

Reset password

post/password/reset/request

Resets the user password with user confirmation. If the user data is kept in the Xsolla data storage or on your side, users receive a password change confirmation email. If the user data is kept in the PlayFab storage, password reset is done on PlayFab’s side. To get more information, see the Comparison of user data storages page.

The workflow of using this call:

  1. The application opens a form so the user can enter their email or username.
  2. The user enters their email or username.
  3. The application sends this request to the Xsolla Login server.
  4. The Xsolla Login server sends a confirmation email to the user.
  5. The user follows the link in the email and proceeds to the form for setting a new password.
  6. The user enters a new password and clicks Set new password.
  7. The application sends the Confirm password reset request to the Xsolla Login server.

If you use your own password reset form, use the Confirm password reset call to reset the user password.

Request
query Parameters
projectId
required
string <uuid>

Login project ID from Publisher Account.

login_url
string

URL to redirect the user to after account confirmation, successful authentication, two-factor authentication configuration, or password reset confirmation. Must be identical to the Callback URL specified in the URL block of Publisher Account. To find it, go to Login > your Login project and select the Callback URLs section in the upper block of the navigation page. Required if there are several Callback URLs.

Request Body schema: application/json
username
required
string

Email to send the password change verification message to.

Responses
204

No Content

400

Bad Request

401

Unauthorized

404

Not Found

422

Unprocessable Entity

429

Too Many Requests

Request samples
application/json
{
  • "username": "John"
}
Response samples
{
  • "error": {
    }
}