requestPasswordResetEmail method

ResponseFuture<MagicLink> requestPasswordResetEmail(
  1. UsersServicePasswordResetReq request, {
  2. CallOptions? options,
})

Initiates the self-service password recovery workflow for a specific username.

Side Effects:

  • If the username is matched, asynchronously dispatches a structured reset email containing a token.
  • Appends a tracking entry to the system security logs.

Note: To prevent user enumeration attacks, this endpoint may return a successful status even if the provided username does not exist in the system.

Implementation

$grpc.ResponseFuture<$3.MagicLink> requestPasswordResetEmail(
  $0.UsersServicePasswordResetReq request, {
  $grpc.CallOptions? options,
}) {
  return $createUnaryCall(_$requestPasswordResetEmail, request,
      options: options);
}