R/send_password_reset_email.R

In firebase.auth.rest: R Wrapper for 'Firebase Authentication REST API'

#' Send password reset email
#'
#' @param email User's email address.
#' @return A named list with the following items:
#' - `email`: Users' email address.
#' - `error`:
#'    - `NULL` if no error code in response
#'    - A list of 2 if response was an error:
#'      - `code`: Error code
#'      - `message`: Error message
#' @details
#' Visit [Firebase Auth REST API docs](https://firebase.google.com/docs/reference/rest/auth#section-send-password-reset-email)
#' for more details
#' @examples
#' \dontrun{
#'   send_password_reset_email("user-email-goes-here")
#' }
#' @export
send_password_reset_email <- function(email) {
  url_path <- "/v1/accounts:sendOobCode"
  data <- list(email = email, requestType = "PASSWORD_RESET")
  perform_req(url_path = url_path, data = data)
}