Lockspire (lockspire v1.0.0)

Copy Markdown

Narrow public API for host applications embedding Lockspire.

Summary

Functions

account_resolver!()

Returns the configured account resolver module, or raises if missing.

config()

Returns a consolidated map of all Lockspire configuration.

issuer()

Returns the configured OIDC issuer string.

logout_path()

Returns the configured logout path.

mount_path()

Functions

account_resolver!()

@spec account_resolver!() :: module()

Returns the configured account resolver module, or raises if missing.

config()

@spec config() :: %{
  repo: module(),
  account_resolver: module(),
  issuer: String.t(),
  mount_path: String.t(),
  logout_path: String.t(),
  oban: keyword()
}

Returns a consolidated map of all Lockspire configuration.

issuer()

@spec issuer() :: String.t()

Returns the configured OIDC issuer string.

logout_path()

@spec logout_path() :: String.t()

Returns the configured logout path.

mount_path()

@spec mount_path() :: String.t()