resetPassword

POST public/resetPassword

Starts a password reset. If the email address belongs to an SC//AcuVigil user, SC//AcuVigil emails that user a temporary password. Use the temporary password with changePassword to set a new password.

Request syntax

curl https://apiv2.acumera.net/public/resetPassword \
  --data-urlencode "email_address=<email_address>"

Request parameters

The request accepts the following parameters in a form-encoded body.

Parameter	Type	Description	Required	Default value
`email_address`	String	The email address (username) of the user whose password you want to reset.	Yes

Response syntax

{
    "success": "string",
    "returnCode": "string",
    "returnMessage": "string"
}

Response parameters

Field	Description
`success`	`"1"` when the request was accepted.
`returnCode`	`PRT` when the request was accepted.
`returnMessage`	A confirmation that includes the email address you sent.

The response is the same whether or not the email address belongs to a user, so it doesn't confirm that an account exists. Only an existing user gets the email.

Errors

If the call fails, success is "0", and returnCode and returnMessage describe the problem. The HTTP status is still 200.

Return code	Message	Cause
`INVALID_EMAIL`	The email address you entered is not valid. Please make sure you typed it correctly.	`email_address` is missing or isn't a valid email address.

Examples

Example: Request a password reset

curl https://apiv2.acumera.net/public/resetPassword \
  --data-urlencode "email_address=pat@example.com"

Response:

{
    "success": "1",
    "returnCode": "PRT",
    "returnMessage": "A password reset mail has been sent to pat@example.com. Check your email for further instructions."
}

Example: Send an address that isn't valid

{
    "success": "0",
    "returnCode": "INVALID_EMAIL",
    "returnMessage": "The email address you entered is not valid. Please make sure you typed it correctly."
}