Lightning.AuthProviders (Lightning v2.13.5)

View Source

Context module for dealing with external Auth Providers.

Summary

Functions

build_handler(name, opts)

create(attrs)

create_handler(config)

@spec create_handler(
  handler_or_config ::
    Lightning.AuthProviders.Handler.t() | Lightning.AuthProviders.AuthConfig.t()
) :: {:ok, Lightning.AuthProviders.Handler.t()} | {:error, term()}

delete!(model)

get_authorize_url(name)

@spec get_authorize_url(String.t() | Lightning.AuthProviders.Handler.t()) ::
  String.t() | nil

Retrieve the authorization url for a given handler or handler name.

get_existing()

@spec get_existing() :: Lightning.AuthProviders.AuthConfig.t() | nil

get_existing(name)

@spec get_existing(name :: String.t()) :: Lightning.AuthProviders.AuthConfig.t() | nil

get_handler(name)

@spec get_handler(name :: String.t()) ::
  {:ok, Lightning.AuthProviders.Handler.t()} | {:error, :not_found}

get_handlers()

@spec get_handlers() :: {:ok, [Lightning.AuthProviders.Handler.t()]}

new()

remove_handler(name)

@spec remove_handler(
  name_or_handler :: String.t() | Lightning.AuthProviders.Handler.t()
) :: {:ok, true}

update(model, attrs)