POST api/v1/Authentication/FinishPasswordReset

Allows the user to finish their password reset using the reset code we send to their email.

Request Information

URI Parameters

Name	Description	Type	Additional information
fields	Use this to only return the data fields you're interested in. Field names not found are ignored and no error is thrown. If no fields are found then the full object is returned.	Collection of string	None.
suppressResponseCodes	Some applications do wonky things if error codes are used. Use this to force 200s to always return.	boolean	None.
APIKey	This is your unique key that identifies you as the developer of this app. Required for all calls.	string	None.
APIToken	This is the user's session token generated when you authenticate the user	string	None.

Body Parameters

The reset code and the user's new password

PasswordResetInformation

Name	Description	Type	Additional information
ResetKey	The key provided to the user's email to reset their password	string	None.
Password	The new password for the user.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "ResetKey": "sample string 1",
  "Password": "sample string 2"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LoginData

Name	Description	Type	Additional information
Authenticated	Whether or not the user was authenticated	boolean	None.
ReAuthenticationToken	If the user set generateReAuthenticationToken to true, this will be populated, otherwise it's empty	string	None.
Me	Contains basic information about the user that just logged in	CurrentUser	None.
SessionToken	The token identifying the current authenticated user, it needs to be passed up with each call	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Authenticated": true,
  "ReAuthenticationToken": "sample string 2",
  "Me": {
    "ID": "b4f5ff79-b884-4713-b11f-3f0189a6415b",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "ImageURL": "sample string 4"
  },
  "SessionToken": "sample string 3"
}