Retrieves the auth module handle from the application configuration. Check https://hexdocs.pm/supabase_gotrue/readme.html#usage

Get the user associated with the current session.

Parameters

• client - The Supabase client to use for the request.
• session - The session to use for the request. Check Supabase.GoTrue.Session for more information.

Examples

iex> session = %Supabase.GoTrue.Session{access_token: "example_token"}
iex> Supabase.GoTrue.get_user(pid | client_name, session)
{:ok, %Supabase.GoTrue.User{}}

@spec resend(Supabase.Client.t(), String.t(), opts) :: :ok | {:error, term()}
when opts:
       [{:redirect_to, String.t()}]
       | [{:captcha_token, String.t()}]
       | [redirect_to: String.t(), captcha_token: String.t()]

Resends a signuo confirm email for the given email address.

Parameters

• client - The Supabase client to use for the request.
• email - A valid user email address to recover password
• opts:
  • redirect_to: the url where the user should be redirected to reset their password
  • captcha_token

Examples

iex> Supabase.GoTrue.resend(client, "john@example.com", redirect_to: "http://localohst:4000/reset-pass") :ok

@spec reset_password_for_email(Supabase.Client.t(), String.t(), opts) ::
  :ok | {:error, term()}
when opts:
       [{:redirect_to, String.t()}]
       | [{:captcha_token, String.t()}]
       | [redirect_to: String.t(), captcha_token: String.t()]

Sends a recovery password email for the given email address.

Parameters

• client - The Supabase client to use for the request.
• email - A valid user email address to recover password
• opts:
  • redirect_to: the url where the user should be redirected to reset their password
  • captcha_token

Examples

iex> Supabase.GoTrue.reset_password_for_email(client, "john@example.com", redirect_to: "http://localohst:4000/reset-pass") :ok

Signs in a user with ID token.

Parameters

• client - The Supabase client to use for the request.
• credentials - The credentials to use for the sign in. Check Supabase.GoTrue.Schemas.SignInWithIdToken for more information.

Examples

iex> credentials = %Supabase.GoTrue.SignInWithIdToken{}
iex> Supabase.GoTrue.sign_in_with_id_token(pid | client_name, credentials)
{:ok, %Supabase.GoTrue.User{}}

Signs in a user with OAuth.

Parameters

• client - The Supabase client to use for the request.
• credentials - The credentials to use for the sign in. Check Supabase.GoTrue.Schemas.SignInWithOauth for more information.

Examples

iex> credentials = %Supabase.GoTrue.SignInWithOauth{}
iex> Supabase.GoTrue.sign_in_with_oauth(pid | client_name, credentials)
{:ok, atom, URI.t()}

Signs in a user with OTP.

Parameters

• client - The Supabase client to use for the request.
• credentials - The credentials to use for the sign in. Check Supabase.GoTrue.Schemas.SignInWithOTP for more information.

Examples

iex> credentials = %Supabase.GoTrue.SignInWithOTP{}
iex> Supabase.GoTrue.sign_in_with_otp(pid | client_name, credentials)
{:ok, %Supabase.GoTrue.Session{}}

Signs in a user with email/phone and password.

Parameters

• client - The Supabase client to use for the request.
• credentials - The credentials to use for the sign in. Check Supabase.GoTrue.Schemas.SignInWithPassword for more information.

Examples

iex> credentials = %Supabase.GoTrue.SignInWithPassword{}
iex> Supabase.GoTrue.sign_in_with_password(pid | client_name, credentials)
{:ok, %Supabase.GoTrue.Session{}}

Signs in a user with SSO.

Parameters

• client - The Supabase client to use for the request.
• credentials - The credentials to use for the sign in. Check Supabase.GoTrue.Schemas.SignInWithSSO for more information.

Examples

iex> credentials = %Supabase.GoTrue.SignInWithSSO{}
iex> Supabase.GoTrue.sign_in_with_sso(pid | client_name, credentials)
{:ok, %Supabase.GoTrue.User{}}

Signs up a user with email/phone and password.

Parameters

• client - The Supabase client to use for the request.
• credentials - The credentials to use for the sign up. Check Supabase.GoTrue.Schemas.SignUpWithPassword for more information.

Examples

iex> credentials = %Supabase.GoTrue.SignUpWithPassword{}
iex> Supabase.GoTrue.sign_up(pid | client_name, credentials)
{:ok, %Supabase.GoTrue.User{}}

@spec update_user(Supabase.Client.t(), conn, Supabase.GoTrue.Schemas.UserParams.t()) ::
  {:ok, conn} | {:error, term()}
when conn: Plug.Conn.t() | Phoenix.LiveView.Socket.t()

Updates the current logged in user.

Parameters

• client - The Supabase client to use for the request.
• conn - The current Plug.Conn or Phoenix.LiveView.Socket to get current user
• attrs - Check UserParams

Examples

iex> params = %{email: "another@example.com", password: "new-pass"}
iex> Supabase.GoTrue.update_user(client, conn, params)
{:ok, conn}

Verifies an OTP code.

Parameters

• client - The Supabase client to use for the request.
• params - The parameters to use for the verification. Check Supabase.GoTrue.Schemas.VerifyOTP for more information.

Examples

iex> params = %Supabase.GoTrue.VerifyOTP{}
iex> Supabase.GoTrue.verify_otp(pid | client_name, params)
{:ok, %Supabase.GoTrue.Session{}}