Miosa.ProjectAuth (Miosa v1.0.0)

Copy Markdown View Source

Project Auth — built-in authentication for generated apps inside sandboxes and deployments.

Example

client = Miosa.client(System.fetch_env!("MIOSA_API_KEY"))

{:ok, status} = Miosa.ProjectAuth.status(client)
{:ok, _} = Miosa.ProjectAuth.enable(client, %{provider: "email"})

Summary

Functions

Disable project auth.

Enable project auth.

Get the current project-auth status and configuration.

Update project-auth configuration.

Functions

disable(client)

@spec disable(Miosa.Client.t()) :: Miosa.Client.result(map())

Disable project auth.

enable(client, config \\ %{})

@spec enable(Miosa.Client.t(), map()) :: Miosa.Client.result(map())

Enable project auth.

Pass an optional config map (e.g. %{provider: "email"}).

status(client)

@spec status(Miosa.Client.t()) :: Miosa.Client.result(map())

Get the current project-auth status and configuration.

update(client, config)

@spec update(Miosa.Client.t(), map()) :: Miosa.Client.result(map())

Update project-auth configuration.