POST /api/passwordmanagement/validatePasswordResetCode

Validates a password reset code. Does not support security challenge questions.

Supported for backwards compatibility, but we recommend using POST /api/passwordmanagement/validatePasswordResetCode instead.

Note: For additional information about password reset, see The Password Reset Process.

Authorization Roles/Permissions: For the operation to complete successfully, the reset code must be a valid result of the sendPasswordResetCode operation which validates that the requestor is a registered user.

This topic includes the following sections:

HTTP Method

POST

URL

https://{hostname}/api/passwordmanagement/passwordmanagement/validatePasswordResetCode?passwordResetCode={ResetCode}

Sample Request

The example below shows a password reset code being sent for validation.

Sample Request URL

https://{hostname}/api/passwordmanagement/passwordmanagement/validatePasswordResetCode?passwordResetCode=134793007454

Sample request headers

POST /api/passwordmanagement/validatePasswordResetCode HTTP/1.1
Host:{hostname}
Accept: application/json, text/javascript, */*; q=0.01
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

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
Content-Type	application/x-www-form-urlencoded
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
passwordResetCode	Form	string	Required	The reset code that was sent to the user in an email as a result of the POST /api/passwordmanagement/sendPasswordResetCode operation.
emailAddress	Form	string	Required	The URL-encoded email address associated with the user ID.

Response

If successful, this operation returns HTTP status code 200, with the username and email as a JSON object.

Sample Response

The sample response below shows the user information returned in JSON format.

Sample response headers

HTTP/1.1 200 OK
Date: Wed, 19 Sep 2012 17:02:05 GMT
Content-Type: application/json

Sample response body

{
  "userName" : "JaneSaoirse",
  "emailAddress" : "jane.saoirse@acmepaymentscorp.com"
}

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

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
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics