gotrue v0.2.1

GoTrue (gotrue v0.2.1) View Source

Elixir wrapper for the GoTrue authentication service.

Link to this section Summary

Functions

client()
client(base_url, api_key)
get_user(jwt)

Get user info using a valid JWT

get_user(client, jwt)
invite(invitation)

Invite a new user to join

invite(client, invitation)
recover(email)

Send a password recovery email

recover(client, email)
refresh_access_token(refresh_token)

Refresh access token using a valid refresh token

refresh_access_token(client, refresh_token)
send_magic_link(email)

Send a magic link (passwordless login)

send_magic_link(client, email)
settings()

Get environment settings for the server

settings(client)
sign_in(credentials)

Sign in with email and password

sign_in(client, credentials)
sign_out(jwt)

Sign out user using a valid JWT

sign_out(client, jwt)
sign_up(credentials)

Sign up a new user with email and password

sign_up(client, credentials)
update_header(client, arg2)
update_user(jwt, info)

Update user info using a valid JWT

update_user(client, jwt, info)
url_for_provider(provider)

Generate a URL for authorizing with an OAUTH2 provider

url_for_provider(base_url, provider)

Link to this section Functions

Link to this function

client()

View Source
Link to this function

client(base_url, api_key)

View Source
Link to this function

get_user(jwt)

View Source

Specs

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

Get user info using a valid JWT

Link to this function

get_user(client, jwt)

View Source
Link to this function

invite(invitation)

View Source

Specs

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

Invite a new user to join

Link to this function

invite(client, invitation)

View Source
Link to this function

recover(email)

View Source

Specs

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

Send a password recovery email

Link to this function

recover(client, email)

View Source
Link to this function

refresh_access_token(refresh_token)

View Source

Specs

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

Refresh access token using a valid refresh token

Link to this function

refresh_access_token(client, refresh_token)

View Source
Link to this function

send_magic_link(email)

View Source

Specs

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

Send a magic link (passwordless login)

Link to this function

send_magic_link(client, email)

View Source
Link to this function

settings()

View Source

Specs

settings() :: map()

Get environment settings for the server

Link to this function

settings(client)

View Source
Link to this function

sign_in(credentials)

View Source

Specs

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

Sign in with email and password

Link to this function

sign_in(client, credentials)

View Source
Link to this function

sign_out(jwt)

View Source

Specs

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

Sign out user using a valid JWT

Link to this function

sign_out(client, jwt)

View Source
Link to this function

sign_up(credentials)

View Source

Specs

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

Sign up a new user with email and password

Link to this function

sign_up(client, credentials)

View Source
Link to this function

update_header(client, arg2)

View Source
Link to this function

update_user(jwt, info)

View Source

Specs

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

Update user info using a valid JWT

Link to this function

update_user(client, jwt, info)

View Source
Link to this function

url_for_provider(provider)

View Source

Specs

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

Generate a URL for authorizing with an OAUTH2 provider

Link to this function

url_for_provider(base_url, provider)

View Source