POST /api/login/authenticateWithPasswordResetCode

Authenticates user with a valid reset code generated with the PasswordManagement API, resets the user's password, and logs the user in.

If security challenge questions are in use, the user's answer is sent in the request message. If the answer is correct, a 200 is returned with a successful reset status. If the answer is invalid, a new challenge is returned with the reset status.

Authorization Roles/Permissions: Authorized user

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/api/login/authenticateWithPasswordResetCode

Sample Request

The example below shows a request to reset the user's password, with a reset code.

Sample Request URL

https://{hostname}/api/login/authenticateWithPasswordResetCode

Sample request headers

POST /api/login/authenticateWithPasswordResetCode HTTP/1.1
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01
Content-Type: application/x-www-form-urlencoded; charset=UTF-8

Sample request body

{
  "Email" : "jane.saoirse@example.com",
  "PasswordResetCode" : "hwP9uvHfC61dOkMPFfVUjbQF1yJIsVlWZi7CylonRJwj6PTJ6TfKlTxcCUKiXW1PRW3NzO63u49l1Gmo2O9ApWGQE2Gs1SkXz4SLI_KNe_A",
  "NewPassword" : "Apples",
  "UserIdentificationChallenge" : {
    "UserID" : "5992539b-0dbd-4091-95cc-80047adf3efa.acmepaymentscorp",
    "ChallengeCode" : "com.soa.challenge.question.color",
    "ChallengeQuestion" : "What is your favorite color?",
    "Answer" : "Black"
  }
}

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
Content-Type	Any one of the following media types is valid for the request Content-Type: application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
passwordReset	Form	PasswordResetRequest	Required	Contains information needed for a user's password reset request.

Response

If successful, this operation returns HTTP status code 200, and the user is logged in.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK

Sample response body

{
  "ResetStatus" : "user.password.reset.valid.answer"
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Response Body

Name	Type	Description
PasswordResetResponse	PasswordResetResponse	Contains information for the response to a user's password reset request.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics