GoTrue (gotrue v0.1.1) View Source

option() ::
  {:method, Tesla.Env.method()}
  | {:url, Tesla.Env.url()}
  | {:query, Tesla.Env.query()}
  | {:headers, Tesla.Env.headers()}
  | {:body, Tesla.Env.body()}
  | {:opts, Tesla.Env.opts()}

Link to this section Functions

get_user(jwt)

Specs

get_user(String.t()) :: {:ok, map()} | {:error, map()}

Get user info using a valid JWT

invite(invitation)

Specs

invite(%{email: String.t(), data: map()}) :: map()

Invite a new user to join

recover(email)

Specs

recover(String.t()) :: :ok | {:error, map()}

Send a password recovery email

refresh_access_token(refresh_token)

Specs

refresh_access_token(String.t()) :: {:ok, map()} | {:error, map()}

Refresh access token using a valid refresh token

send_magic_link(email)

Specs

send_magic_link(String.t()) :: :ok | {:error, map()}

Send a magic link (passwordless login)

settings()

Specs

settings() :: map()

Get environment settings for the GoTrue server

sign_in(credentials)

Specs

sign_in(%{email: String.t(), password: String.t()}) ::
  {:ok, map()} | {:error, map()}

sign_out(jwt)

Specs

sign_out(String.t()) :: :ok | {:error, map()}

Sign out user using a valid JWT

sign_up(credentials)

Specs

sign_up(%{
  email: String.t(),
  password: String.t(),
  data: map(),
  audience: String.t(),
  provider: String.t()
}) :: map()

update_user(jwt, info)

Specs

update_user(String.t(), map()) :: {:ok, map()} | {:error, map()}

Update user info using a valid JWT

url_for_provider(provider)

Specs

url_for_provider(String.t()) :: String.t()

Generate a URL for authorizing with an OAUTH2 provider