POST /users/password-reset-by-email - Initiates a password reset process for a user.

  • This endpoint is only available for Auth0.

Body:

Path Parameters:

  • None

Query Parameters:

  • None


Status Code Meaning When it Happens
400 Bad Request Missing or invalid parameters
401 Unauthorized Missing or invalid authentication token
404 Not Found User not found
429 Too Many Requests Rate limit exceeded
500 Internal Server Error Unexpected error
{
"error": "Detailed error message here"
}

POST /users/password-reset-by-email
{
"provider": "auth0-user",
"email": "user@district.com",
"clientId": "client_xyz",
"connection": "connection_name",
"accountProvider": "account_provider_name"
}
  • This response contains a URL for the user to reset their password.
{
"url": "password reset url"
}

  • Parameters

    • event: APIGatewayProxyEvent

      The API Gateway event containing the request.

    • context: Context
    • callback: Callback<APIGatewayProxyResult>

    Returns void | Promise<APIGatewayProxyResult>

    A Promise resolving to an API Gateway-compatible response.