Account Management - Reset Password
Reset a player's password for a given title.
POST https://titleId.playfabapi.com/Admin/ResetPasswordRequest Header
| Name | Required | Type | Description |
|---|---|---|---|
| X-SecretKey | True |
string |
This API requires a title secret key, available to title admins, from PlayFab Game Manager. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| Password | True |
string |
The new password for the player. |
| Token | True |
string |
The token of the player requesting the password reset. |
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ||
| 400 Bad Request |
This is the outer wrapper for all responses with errors |
Security
X-SecretKey
This API requires a title secret key, available to title admins, from PlayFab Game Manager.
Type:
apiKey
In:
header
Definitions
| Name | Description |
|---|---|
|
Api |
The basic wrapper around every failed API response |
|
Reset |
Resets a player's password taking in a new password based and validating the user based off of a token sent to the playerto their email. The token expires after 30 minutes. |
|
Reset |
ApiErrorWrapper
The basic wrapper around every failed API response
| Name | Type | Description |
|---|---|---|
| code |
integer |
Numerical HTTP code |
| error |
string |
Playfab error code |
| errorCode |
integer |
Numerical PlayFab error code |
| errorDetails |
object |
Detailed description of individual issues with the request object |
| errorMessage |
string |
Description for the PlayFab errorCode |
| status |
string |
String HTTP code |
ResetPasswordRequest
Resets a player's password taking in a new password based and validating the user based off of a token sent to the playerto their email. The token expires after 30 minutes.
| Name | Type | Description |
|---|---|---|
| CustomTags |
object |
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). |
| Password |
string |
The new password for the player. |
| Token |
string |
The token of the player requesting the password reset. |
ResetPasswordResult
Error Codes
| Name | Code |
|---|---|
| AuthTokenAlreadyUsedToResetPassword | 1329 |
| AuthTokenDoesNotExist | 1327 |
| AuthTokenExpired | 1328 |
| InvalidAuthToken | 1326 |
| NoContactEmailAddressFound | 1325 |